1.204.0

interface ServerDeploymentGroupProps

LanguageType name
.NETAmazon.CDK.AWS.CodeDeploy.ServerDeploymentGroupProps
Javasoftware.amazon.awscdk.services.codedeploy.ServerDeploymentGroupProps
Pythonaws_cdk.aws_codedeploy.ServerDeploymentGroupProps
TypeScript (source)@aws-cdk/aws-codedeploy » ServerDeploymentGroupProps

Construction properties for {@link ServerDeploymentGroup}.

Example

import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';

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

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 {@link #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 {@link #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 {@link #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 {@link #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.

← PreviousNext →