interface ServerDeploymentGroupProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CodeDeploy.ServerDeploymentGroupProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#ServerDeploymentGroupProps |
 Java | software.amazon.awscdk.services.codedeploy.ServerDeploymentGroupProps |
 Python | aws_cdk.aws_codedeploy.ServerDeploymentGroupProps |
 TypeScript (source) | aws-cdk-lib » aws_codedeploy » ServerDeploymentGroupProps |
Construction properties for ServerDeploymentGroup.
Example
declare const alb: elbv2.ApplicationLoadBalancer;
const listener = alb.addListener('Listener', { port: 80 });
const targetGroup = listener.addTargets('Fleet', { port: 80 });
const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'DeploymentGroup', {
loadBalancer: codedeploy.LoadBalancer.application(targetGroup),
});
Properties
| Name | Type | Description |
|---|---|---|
| alarms? | IAlarm[] | The CloudWatch alarms associated with this Deployment Group. |
| application? | IServer | The CodeDeploy EC2/on-premise Application this Deployment Group belongs to. |
| auto | Auto | The auto-rollback configuration for this Deployment Group. |
| auto | IAuto[] | The auto-scaling groups belonging to this Deployment Group. |
| deployment | IServer | The EC2/on-premise Deployment Configuration to use for this Deployment Group. |
| deployment | string | The physical, human-readable name of the CodeDeploy Deployment Group. |
| ec2 | Instance | All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. |
| ignore | boolean | Whether to skip the step of checking CloudWatch alarms during the deployment process. |
| ignore | boolean | Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. |
| install | boolean | 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. |
| load | Load | The load balancer to place in front of this Deployment Group. |
| load | Load[] | CodeDeploy supports the deployment to multiple load balancers. |
| on | Instance | All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. |
| role? | IRole | The service Role of this Deployment Group. |
| termination | boolean | Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling 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:
IServer
(optional, default: A new Application will be created.)
The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.
autoRollback?
Type:
Auto
(optional, default: default AutoRollbackConfig.)
The auto-rollback configuration for this Deployment Group.
autoScalingGroups?
Type:
IAuto[]
(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:
IServer
(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:
Instance
(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.
ignoreAlarmConfiguration?
Type:
boolean
(optional, default: false)
Whether to skip the step of checking CloudWatch alarms during the deployment process.
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?
⚠️ Deprecated: - Use loadBalancers instead.
Type:
Load
(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.
loadBalancers?
Type:
Load[]
(optional, default: Deployment Group will not have load balancers defined.)
CodeDeploy supports the deployment to multiple load balancers.
Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups.
onPremiseInstanceTags?
Type:
Instance
(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.
terminationHook?
Type:
boolean
(optional, default: false)
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.