aws-cdk-lib.aws_codedeploy.ServerDeploymentGroup

class ServerDeploymentGroup (construct)

LanguageType name
.NETAmazon.CDK.AWS.CodeDeploy.ServerDeploymentGroup
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#ServerDeploymentGroup
Javasoftware.amazon.awscdk.services.codedeploy.ServerDeploymentGroup
Pythonaws_cdk.aws_codedeploy.ServerDeploymentGroup
TypeScript (source)aws-cdk-lib » aws_codedeploy » ServerDeploymentGroup

Implements IConstruct, IDependable, IResource, IServerDeploymentGroup

A CodeDeploy Deployment Group that deploys to EC2/on-premise instances.

Example

import * as elb from 'aws-cdk-lib/aws-elasticloadbalancing';

declare const lb: elb.LoadBalancer;
lb.addListener({
  externalPort: 80,
});

const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'DeploymentGroup', {
  loadBalancer: codedeploy.LoadBalancer.classic(lb),
});

Initializer

new ServerDeploymentGroup(scope: Construct, id: string, props?: ServerDeploymentGroupProps)

Parameters

  • scope Construct
  • id string
  • props ServerDeploymentGroupProps

Construct Props

NameTypeDescription
alarms?IAlarm[]The CloudWatch alarms associated with this Deployment Group.
application?IServerApplicationThe CodeDeploy EC2/on-premise Application this Deployment Group belongs to.
autoRollback?AutoRollbackConfigThe auto-rollback configuration for this Deployment Group.
autoScalingGroups?IAutoScalingGroup[]The auto-scaling groups belonging to this Deployment Group.
deploymentConfig?IServerDeploymentConfigThe EC2/on-premise Deployment Configuration to use for this Deployment Group.
deploymentGroupName?stringThe physical, human-readable name of the CodeDeploy Deployment Group.
ec2InstanceTags?InstanceTagSetAll EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
ignorePollAlarmsFailure?booleanWhether to continue a deployment even if fetching the alarm status from CloudWatch failed.
installAgent?booleanIf you've provided any auto-scaling groups with the #autoScalingGroups property, you can set this property to add User Data that installs the CodeDeploy agent on the instances.
loadBalancer?LoadBalancerThe load balancer to place in front of this Deployment Group.
onPremiseInstanceTags?InstanceTagSetAll on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
role?IRoleThe service Role of this Deployment Group.

alarms?

Type: IAlarm[] (optional, default: [])

The CloudWatch alarms associated with this Deployment Group.

CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.

Alarms can also be added after the Deployment Group is created using the #addAlarm method.

See also: https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html


application?

Type: IServerApplication (optional, default: A new Application will be created.)

The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.


autoRollback?

Type: AutoRollbackConfig (optional, default: default AutoRollbackConfig.)

The auto-rollback configuration for this Deployment Group.


autoScalingGroups?

Type: IAutoScalingGroup[] (optional, default: [])

The auto-scaling groups belonging to this Deployment Group.

Auto-scaling groups can also be added after the Deployment Group is created using the #addAutoScalingGroup method.

[disable-awslint:ref-via-interface] is needed because we update userdata for ASGs to install the codedeploy agent.


deploymentConfig?

Type: IServerDeploymentConfig (optional, default: ServerDeploymentConfig#OneAtATime)

The EC2/on-premise Deployment Configuration to use for this Deployment Group.


deploymentGroupName?

Type: string (optional, default: An auto-generated name will be used.)

The physical, human-readable name of the CodeDeploy Deployment Group.


ec2InstanceTags?

Type: InstanceTagSet (optional, default: No additional EC2 instances will be added to the Deployment Group.)

All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.


ignorePollAlarmsFailure?

Type: boolean (optional, default: false)

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.


installAgent?

Type: boolean (optional, default: true)

If you've provided any auto-scaling groups with the #autoScalingGroups property, you can set this property to add User Data that installs the CodeDeploy agent on the instances.

See also: https://docs.aws.amazon.com/codedeploy/latest/userguide/codedeploy-agent-operations-install.html


loadBalancer?

Type: LoadBalancer (optional, default: Deployment Group will not have a load balancer defined.)

The load balancer to place in front of this Deployment Group.

Can be created from either a classic Elastic Load Balancer, or an Application Load Balancer / Network Load Balancer Target Group.


onPremiseInstanceTags?

Type: InstanceTagSet (optional, default: No additional on-premise instances will be added to the Deployment Group.)

All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.


role?

Type: IRole (optional, default: A new Role will be created.)

The service Role of this Deployment Group.

Properties

NameTypeDescription
applicationIServerApplication
deploymentConfigIServerDeploymentConfig
deploymentGroupArnstringThe ARN of the Deployment Group.
deploymentGroupNamestringThe name of the Deployment Group.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
autoScalingGroups?IAutoScalingGroup[]
role?IRoleThe service Role of this Deployment Group.

application

Type: IServerApplication


deploymentConfig

Type: IServerDeploymentConfig


deploymentGroupArn

Type: string

The ARN of the Deployment Group.


deploymentGroupName

Type: string

The name of the Deployment Group.


env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


autoScalingGroups?

Type: IAutoScalingGroup[] (optional)


role?

Type: IRole (optional)

The service Role of this Deployment Group.

Methods

NameDescription
addAlarm(alarm)Associates an additional alarm with this Deployment Group.
addAutoScalingGroup(asg)Adds an additional auto-scaling group to this Deployment Group.
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromServerDeploymentGroupAttributes(scope, id, attrs)Import an EC2/on-premise Deployment Group defined either outside the CDK app, or in a different region.

addAlarm(alarm)

public addAlarm(alarm: IAlarm): void

Parameters

  • alarm IAlarm — the alarm to associate with this Deployment Group.

Associates an additional alarm with this Deployment Group.


addAutoScalingGroup(asg)

public addAutoScalingGroup(asg: AutoScalingGroup): void

Parameters

  • asg AutoScalingGroup — the auto-scaling group to add to this Deployment Group.

Adds an additional auto-scaling group to this Deployment Group.


applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromServerDeploymentGroupAttributes(scope, id, attrs)

public static fromServerDeploymentGroupAttributes(scope: Construct, id: string, attrs: ServerDeploymentGroupAttributes): IServerDeploymentGroup

Parameters

  • scope Construct — the parent Construct for this new Construct.
  • id string — the logical ID of this new Construct.
  • attrs ServerDeploymentGroupAttributes — the properties of the referenced Deployment Group.

Returns

  • IServerDeploymentGroup

Import an EC2/on-premise Deployment Group defined either outside the CDK app, or in a different region.