Skip to content
v2.274.0

ServerDeploymentGroupProps Struct ​

Construction properties for ServerDeploymentGroup.

Example ​

ts
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 ​

alarmsIAlarmRef[]alarmstyping.List[IAlarmRef]alarmsList<IAlarmRef>AlarmsIAlarmRef[]Alarms*[]IAlarmRef= []#
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.

applicationIApplicationRefapplicationIApplicationRefapplicationIApplicationRefApplicationIApplicationRefApplicationIApplicationRef= A new Application will be create…#
The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.
default

Default: A new Application will be created.

autoRollbackAutoRollbackConfigauto_rollbackAutoRollbackConfigautoRollbackAutoRollbackConfigAutoRollbackAutoRollbackConfigAutoRollbackAutoRollbackConfig= default AutoRollbackConfig.#
The auto-rollback configuration for this Deployment Group.
autoScalingGroupsIAutoScalingGroup[]auto_scaling_groupstyping.List[IAutoScalingGroup]autoScalingGroupsList<IAutoScalingGroup>AutoScalingGroupsIAutoScalingGroup[]AutoScalingGroups*[]IAutoScalingGroup= []#
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.

deploymentConfigIDeploymentConfigRefdeployment_configIDeploymentConfigRefdeploymentConfigIDeploymentConfigRefDeploymentConfigIDeploymentConfigRefDeploymentConfigIDeploymentConfigRef= ServerDeploymentConfig#OneAtATim…#
The EC2/on-premise Deployment Configuration to use for this Deployment Group.
default

Default: ServerDeploymentConfig#OneAtATime

deploymentGroupNamestringdeployment_group_namestrdeploymentGroupNameStringDeploymentGroupNamestringDeploymentGroupName*string= An auto-generated name will be u…#
The physical, human-readable name of the CodeDeploy Deployment Group.
default

Default: An auto-generated name will be used.

ec2InstanceTagsInstanceTagSetec2_instance_tagsInstanceTagSetec2InstanceTagsInstanceTagSetEc2InstanceTagsInstanceTagSetEc2InstanceTagsInstanceTagSet= No additional EC2 instances will…#
All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
default

Default: No additional EC2 instances will be added to the Deployment Group.

ignoreAlarmConfigurationbooleanignore_alarm_configurationboolignoreAlarmConfigurationBooleanIgnoreAlarmConfigurationboolIgnoreAlarmConfiguration*bool= false#
Whether to skip the step of checking CloudWatch alarms during the deployment process.
ignorePollAlarmsFailurebooleanignore_poll_alarms_failureboolignorePollAlarmsFailureBooleanIgnorePollAlarmsFailureboolIgnorePollAlarmsFailure*bool= false#
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
installAgentbooleaninstall_agentboolinstallAgentBooleanInstallAgentboolInstallAgent*bool= 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.
loadBalancerLoadBalancerload_balancerLoadBalancerloadBalancerLoadBalancerLoadBalancerLoadBalancerLoadBalancerLoadBalancer= Deployment Group will not have a…deprecated#
- Use `loadBalancers` instead.

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

default

Default: Deployment Group will not have a load balancer defined.

loadBalancersLoadBalancer[]load_balancerstyping.List[LoadBalancer]loadBalancersList<LoadBalancer>LoadBalancersLoadBalancer[]LoadBalancers*[]LoadBalancer= Deployment Group will not have l…#
CodeDeploy supports the deployment to multiple load balancers.

Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups.

default

Default: Deployment Group will not have load balancers defined.

onPremiseInstanceTagsInstanceTagSeton_premise_instance_tagsInstanceTagSetonPremiseInstanceTagsInstanceTagSetOnPremiseInstanceTagsInstanceTagSetOnPremiseInstanceTagsInstanceTagSet= No additional on-premise instanc…#
All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
default

Default: No additional on-premise instances will be added to the Deployment Group.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= A new Role will be created.#
The service Role of this Deployment Group.
terminationHookbooleantermination_hookboolterminationHookBooleanTerminationHookboolTerminationHook*bool= false#
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

Used as props by ​