Namespace Amazon.CDK.AWS.CodeDeploy

AWS CodeDeploy Construct Library

---

AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances, serverless Lambda functions, or Amazon ECS services.

The CDK currently supports Amazon EC2, on-premise and AWS Lambda applications.

EC2/on-premise Applications

To create a new CodeDeploy Application that deploys to EC2/on-premise instances:

var application = new ServerApplication(this, "CodeDeployApplication", new ServerApplicationProps {
    ApplicationName = "MyApplication"
});

To import an already existing Application:

var application = ServerApplication.FromServerApplicationName(this, "ExistingCodeDeployApplication", "MyExistingApplication");

EC2/on-premise Deployment Groups

To create a new CodeDeploy Deployment Group that deploys to EC2/on-premise instances:

using Amazon.CDK.AWS.AutoScaling;
using Amazon.CDK.AWS.CloudWatch;

ServerApplication application;
AutoScalingGroup asg;
Alarm alarm;

var deploymentGroup = new ServerDeploymentGroup(this, "CodeDeployDeploymentGroup", new ServerDeploymentGroupProps {
    Application = application,
    DeploymentGroupName = "MyDeploymentGroup",
    AutoScalingGroups = new [] { asg },
    // adds User Data that installs the CodeDeploy agent on your auto-scaling groups hosts
    // default: true
    InstallAgent = true,
    // adds EC2 instances matching tags
    Ec2InstanceTags = new InstanceTagSet(new Dictionary<string, string[]> {
        // any instance with tags satisfying
        // key1=v1 or key1=v2 or key2 (any value) or value v3 (any key)
        // will match this group
        { "key1", new [] { "v1", "v2" } },
        { "key2", new [] {  } },
        { "", new [] { "v3" } }
    }),
    // adds on-premise instances matching tags
    OnPremiseInstanceTags = new InstanceTagSet(new Dictionary<string, string[]> {
        { "key1", new [] { "v1", "v2" } }
    }, new Dictionary<string, string[]> {
        { "key2", new [] { "v3" } }
    }),
    // CloudWatch alarms
    Alarms = new [] { alarm },
    // whether to ignore failure to fetch the status of alarms from CloudWatch
    // default: false
    IgnorePollAlarmsFailure = false,
    // auto-rollback configuration
    AutoRollback = new AutoRollbackConfig {
        FailedDeployment = true,  // default: true
        StoppedDeployment = true,  // default: false
        DeploymentInAlarm = true
    }
});

All properties are optional - if you don't provide an Application, one will be automatically created.

To import an already existing Deployment Group:

ServerApplication application;

var deploymentGroup = ServerDeploymentGroup.FromServerDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", new ServerDeploymentGroupAttributes {
    Application = application,
    DeploymentGroupName = "MyExistingDeploymentGroup"
});

Load balancers

You can specify a load balancer with the loadBalancer property when creating a Deployment Group.

LoadBalancer is an abstract class with static factory methods that allow you to create instances of it from various sources.

With Classic Elastic Load Balancer, you provide it directly:

using Amazon.CDK.AWS.ElasticLoadBalancing;

LoadBalancer lb;

lb.AddListener(new LoadBalancerListener {
    ExternalPort = 80
});

var deploymentGroup = new ServerDeploymentGroup(this, "DeploymentGroup", new ServerDeploymentGroupProps {
    LoadBalancer = LoadBalancer.Classic(lb)
});

With Application Load Balancer or Network Load Balancer, you provide a Target Group as the load balancer:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;

ApplicationLoadBalancer alb;

var listener = alb.AddListener("Listener", new BaseApplicationListenerProps { Port = 80 });
var targetGroup = listener.AddTargets("Fleet", new AddApplicationTargetsProps { Port = 80 });

var deploymentGroup = new ServerDeploymentGroup(this, "DeploymentGroup", new ServerDeploymentGroupProps {
    LoadBalancer = LoadBalancer.Application(targetGroup)
});

Deployment Configurations

You can also pass a Deployment Configuration when creating the Deployment Group:

var deploymentGroup = new ServerDeploymentGroup(this, "CodeDeployDeploymentGroup", new ServerDeploymentGroupProps {
    DeploymentConfig = ServerDeploymentConfig.ALL_AT_ONCE
});

The default Deployment Configuration is ServerDeploymentConfig.ONE_AT_A_TIME.

You can also create a custom Deployment Configuration:

var deploymentConfig = new ServerDeploymentConfig(this, "DeploymentConfiguration", new ServerDeploymentConfigProps {
    DeploymentConfigName = "MyDeploymentConfiguration",  // optional property
    // one of these is required, but both cannot be specified at the same time
    MinimumHealthyHosts = MinimumHealthyHosts.Count(2)
});

Or import an existing one:

var deploymentConfig = ServerDeploymentConfig.FromServerDeploymentConfigName(this, "ExistingDeploymentConfiguration", "MyExistingDeploymentConfiguration");

Lambda Applications

To create a new CodeDeploy Application that deploys to a Lambda function:

var application = new LambdaApplication(this, "CodeDeployApplication", new LambdaApplicationProps {
    ApplicationName = "MyApplication"
});

To import an already existing Application:

var application = LambdaApplication.FromLambdaApplicationName(this, "ExistingCodeDeployApplication", "MyExistingApplication");

Lambda Deployment Groups

To enable traffic shifting deployments for Lambda functions, CodeDeploy uses Lambda Aliases, which can balance incoming traffic between two different versions of your function. Before deployment, the alias sends 100% of invokes to the version used in production. When you publish a new version of the function to your stack, CodeDeploy will send a small percentage of traffic to the new version, monitor, and validate before shifting 100% of traffic to the new version.

To create a new CodeDeploy Deployment Group that deploys to a Lambda function:

LambdaApplication myApplication;
Function func;

var version = func.CurrentVersion;
var version1Alias = new Alias(this, "alias", new AliasProps {
    AliasName = "prod",
    Version = version
});

var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
    Application = myApplication,  // optional property: one will be created for you if not provided
    Alias = version1Alias,
    DeploymentConfig = LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE
});

In order to deploy a new version of this function:

Create a custom Deployment Config

CodeDeploy for Lambda comes with built-in configurations for traffic shifting. If you want to specify your own strategy, you can do so with the CustomLambdaDeploymentConfig construct, letting you specify precisely how fast a new function version is deployed.

LambdaApplication application;
Alias alias;
var config = new CustomLambdaDeploymentConfig(this, "CustomConfig", new CustomLambdaDeploymentConfigProps {
    Type = CustomLambdaDeploymentConfigType.CANARY,
    Interval = Duration.Minutes(1),
    Percentage = 5
});
var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
    Application = application,
    Alias = alias,
    DeploymentConfig = config
});

You can specify a custom name for your deployment config, but if you do you will not be able to update the interval/percentage through CDK.

var config = new CustomLambdaDeploymentConfig(this, "CustomConfig", new CustomLambdaDeploymentConfigProps {
    Type = CustomLambdaDeploymentConfigType.CANARY,
    Interval = Duration.Minutes(1),
    Percentage = 5,
    DeploymentConfigName = "MyDeploymentConfig"
});

Rollbacks and Alarms

CodeDeploy will roll back if the deployment fails. You can optionally trigger a rollback when one or more alarms are in a failed state:

using Amazon.CDK.AWS.CloudWatch;

Alias alias;

// or add alarms to an existing group
Alias blueGreenAlias;

var alarm = new Alarm(this, "Errors", new AlarmProps {
    ComparisonOperator = ComparisonOperator.GREATER_THAN_THRESHOLD,
    Threshold = 1,
    EvaluationPeriods = 1,
    Metric = alias.MetricErrors()
});
var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
    Alias = alias,
    DeploymentConfig = LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,
    Alarms = new [] { alarm }
});
deploymentGroup.AddAlarm(new Alarm(this, "BlueGreenErrors", new AlarmProps {
    ComparisonOperator = ComparisonOperator.GREATER_THAN_THRESHOLD,
    Threshold = 1,
    EvaluationPeriods = 1,
    Metric = blueGreenAlias.MetricErrors()
}));

Pre and Post Hooks

CodeDeploy allows you to run an arbitrary Lambda function before traffic shifting actually starts (PreTraffic Hook) and after it completes (PostTraffic Hook). With either hook, you have the opportunity to run logic that determines whether the deployment must succeed or fail. For example, with PreTraffic hook you could run integration tests against the newly created Lambda version (but not serving traffic). With PostTraffic hook, you could run end-to-end validation checks.

Function warmUpUserCache;
Function endToEndValidation;
Alias alias;


// pass a hook whe creating the deployment group
var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
    Alias = alias,
    DeploymentConfig = LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,
    PreHook = warmUpUserCache
});

// or configure one on an existing deployment group
deploymentGroup.AddPostHook(endToEndValidation);

Import an existing Deployment Group

To import an already existing Deployment Group:

LambdaApplication application;

var deploymentGroup = LambdaDeploymentGroup.FromLambdaDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", new LambdaDeploymentGroupAttributes {
    Application = application,
    DeploymentGroupName = "MyExistingDeploymentGroup"
});

Classes

AutoRollbackConfig	The configuration for automatically rolling back deployments in a given Deployment Group.
CfnApplication	A CloudFormation `AWS::CodeDeploy::Application`.
CfnApplicationProps	Properties for defining a `CfnApplication`.
CfnDeploymentConfig	A CloudFormation `AWS::CodeDeploy::DeploymentConfig`.
CfnDeploymentConfig.MinimumHealthyHostsProperty	`MinimumHealthyHosts` is a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.
CfnDeploymentConfig.TimeBasedCanaryProperty	A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.
CfnDeploymentConfig.TimeBasedLinearProperty	A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment.
CfnDeploymentConfig.TrafficRoutingConfigProperty	The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
CfnDeploymentConfigProps	Properties for defining a `CfnDeploymentConfig`.
CfnDeploymentGroup	A CloudFormation `AWS::CodeDeploy::DeploymentGroup`.
CfnDeploymentGroup.AlarmConfigurationProperty	The `AlarmConfiguration` property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.AlarmProperty	The `Alarm` property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.AutoRollbackConfigurationProperty	The `AutoRollbackConfiguration` property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.
CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty	Information about blue/green deployment options for a deployment group.
CfnDeploymentGroup.BlueInstanceTerminationOptionProperty	Information about whether instances in the original environment are terminated when a blue/green deployment is successful.
CfnDeploymentGroup.DeploymentProperty	`Deployment` is a property of the DeploymentGroup resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete.
CfnDeploymentGroup.DeploymentReadyOptionProperty	Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
CfnDeploymentGroup.DeploymentStyleProperty	Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
CfnDeploymentGroup.EC2TagFilterProperty	Information about an Amazon EC2 tag filter.
CfnDeploymentGroup.EC2TagSetListObjectProperty	The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.EC2TagSetProperty	The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.ECSServiceProperty	Contains the service and cluster names used to identify an Amazon ECS deployment's target.
CfnDeploymentGroup.ELBInfoProperty	The `ELBInfo` property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group.
CfnDeploymentGroup.GitHubLocationProperty	`GitHubLocation` is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in GitHub.
CfnDeploymentGroup.GreenFleetProvisioningOptionProperty	Information about the instances that belong to the replacement environment in a blue/green deployment.
CfnDeploymentGroup.LoadBalancerInfoProperty	The `LoadBalancerInfo` property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.OnPremisesTagSetListObjectProperty	The `OnPremisesTagSetListObject` property type specifies lists of on-premises instance tag groups.
CfnDeploymentGroup.OnPremisesTagSetProperty	The `OnPremisesTagSet` property type specifies a list containing other lists of on-premises instance tag groups.
CfnDeploymentGroup.RevisionLocationProperty	`RevisionLocation` is a property that defines the location of the CodeDeploy application revision to deploy.
CfnDeploymentGroup.S3LocationProperty	`S3Location` is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).
CfnDeploymentGroup.TagFilterProperty	`TagFilter` is a property type of the AWS::CodeDeploy::DeploymentGroup resource that specifies which on-premises instances to associate with the deployment group. To register on-premise instances with AWS CodeDeploy , see Configure Existing On-Premises Instances by Using AWS CodeDeploy in the AWS CodeDeploy User Guide .
CfnDeploymentGroup.TargetGroupInfoProperty	The `TargetGroupInfo` property type specifies information about a target group in Elastic Load Balancing to use in a deployment.
CfnDeploymentGroup.TargetGroupPairInfoProperty
CfnDeploymentGroup.TrafficRouteProperty
CfnDeploymentGroup.TriggerConfigProperty	Information about notification triggers for the deployment group.
CfnDeploymentGroupProps	Properties for defining a `CfnDeploymentGroup`.
CustomLambdaDeploymentConfig	A custom Deployment Configuration for a Lambda Deployment Group.
CustomLambdaDeploymentConfigProps	Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
CustomLambdaDeploymentConfigType	Lambda Deployment config type.
EcsApplication	A CodeDeploy Application that deploys to an Amazon ECS service.
EcsApplicationProps	Construction properties for {@link EcsApplication}.
EcsDeploymentConfig	A custom Deployment Configuration for an ECS Deployment Group.
EcsDeploymentGroup	Note: This class currently stands as a namespaced container for importing an ECS Deployment Group defined outside the CDK app until CloudFormation supports provisioning ECS Deployment Groups.
EcsDeploymentGroupAttributes	Properties of a reference to a CodeDeploy ECS Deployment Group.
InstanceTagSet	Represents a set of instance tag groups.
LambdaApplication	A CodeDeploy Application that deploys to an AWS Lambda function.
LambdaApplicationProps	Construction properties for {@link LambdaApplication}.
LambdaDeploymentConfig	A custom Deployment Configuration for a Lambda Deployment Group.
LambdaDeploymentConfigImportProps	Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
LambdaDeploymentGroup
LambdaDeploymentGroupAttributes	Properties of a reference to a CodeDeploy Lambda Deployment Group.
LambdaDeploymentGroupProps	Construction properties for {@link LambdaDeploymentGroup}.
LoadBalancer	An interface of an abstract load balancer, as needed by CodeDeploy.
LoadBalancerGeneration	The generations of AWS load balancing solutions.
MinimumHealthyHosts	Minimum number of healthy hosts for a server deployment.
ServerApplication	A CodeDeploy Application that deploys to EC2/on-premise instances.
ServerApplicationProps	Construction properties for {@link ServerApplication}.
ServerDeploymentConfig	A custom Deployment Configuration for an EC2/on-premise Deployment Group.
ServerDeploymentConfigProps	Construction properties of {@link ServerDeploymentConfig}.
ServerDeploymentGroup	A CodeDeploy Deployment Group that deploys to EC2/on-premise instances.
ServerDeploymentGroupAttributes	Properties of a reference to a CodeDeploy EC2/on-premise Deployment Group.
ServerDeploymentGroupProps	Construction properties for {@link ServerDeploymentGroup}.

Interfaces

CfnDeploymentConfig.IMinimumHealthyHostsProperty	`MinimumHealthyHosts` is a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.
CfnDeploymentConfig.ITimeBasedCanaryProperty	A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.
CfnDeploymentConfig.ITimeBasedLinearProperty	A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment.
CfnDeploymentConfig.ITrafficRoutingConfigProperty	The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
CfnDeploymentGroup.IAlarmConfigurationProperty	The `AlarmConfiguration` property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.IAlarmProperty	The `Alarm` property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.IAutoRollbackConfigurationProperty	The `AutoRollbackConfiguration` property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.
CfnDeploymentGroup.IBlueGreenDeploymentConfigurationProperty	Information about blue/green deployment options for a deployment group.
CfnDeploymentGroup.IBlueInstanceTerminationOptionProperty	Information about whether instances in the original environment are terminated when a blue/green deployment is successful.
CfnDeploymentGroup.IDeploymentProperty	`Deployment` is a property of the DeploymentGroup resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete.
CfnDeploymentGroup.IDeploymentReadyOptionProperty	Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
CfnDeploymentGroup.IDeploymentStyleProperty	Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
CfnDeploymentGroup.IEC2TagFilterProperty	Information about an Amazon EC2 tag filter.
CfnDeploymentGroup.IEC2TagSetListObjectProperty	The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.IEC2TagSetProperty	The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
CfnDeploymentGroup.IECSServiceProperty	Contains the service and cluster names used to identify an Amazon ECS deployment's target.
CfnDeploymentGroup.IELBInfoProperty	The `ELBInfo` property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group.
CfnDeploymentGroup.IGitHubLocationProperty	`GitHubLocation` is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in GitHub.
CfnDeploymentGroup.IGreenFleetProvisioningOptionProperty	Information about the instances that belong to the replacement environment in a blue/green deployment.
CfnDeploymentGroup.ILoadBalancerInfoProperty	The `LoadBalancerInfo` property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.
CfnDeploymentGroup.IOnPremisesTagSetListObjectProperty	The `OnPremisesTagSetListObject` property type specifies lists of on-premises instance tag groups.
CfnDeploymentGroup.IOnPremisesTagSetProperty	The `OnPremisesTagSet` property type specifies a list containing other lists of on-premises instance tag groups.
CfnDeploymentGroup.IRevisionLocationProperty	`RevisionLocation` is a property that defines the location of the CodeDeploy application revision to deploy.
CfnDeploymentGroup.IS3LocationProperty	`S3Location` is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).
CfnDeploymentGroup.ITagFilterProperty	`TagFilter` is a property type of the AWS::CodeDeploy::DeploymentGroup resource that specifies which on-premises instances to associate with the deployment group. To register on-premise instances with AWS CodeDeploy , see Configure Existing On-Premises Instances by Using AWS CodeDeploy in the AWS CodeDeploy User Guide .
CfnDeploymentGroup.ITargetGroupInfoProperty	The `TargetGroupInfo` property type specifies information about a target group in Elastic Load Balancing to use in a deployment.
CfnDeploymentGroup.ITargetGroupPairInfoProperty
CfnDeploymentGroup.ITrafficRouteProperty
CfnDeploymentGroup.ITriggerConfigProperty	Information about notification triggers for the deployment group.
IAutoRollbackConfig	The configuration for automatically rolling back deployments in a given Deployment Group.
ICfnApplicationProps	Properties for defining a `CfnApplication`.
ICfnDeploymentConfigProps	Properties for defining a `CfnDeploymentConfig`.
ICfnDeploymentGroupProps	Properties for defining a `CfnDeploymentGroup`.
ICustomLambdaDeploymentConfigProps	Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
IEcsApplication	Represents a reference to a CodeDeploy Application deploying to Amazon ECS.
IEcsApplicationProps	Construction properties for {@link EcsApplication}.
IEcsDeploymentConfig	The Deployment Configuration of an ECS Deployment Group.
IEcsDeploymentGroup	Interface for an ECS deployment group.
IEcsDeploymentGroupAttributes	Properties of a reference to a CodeDeploy ECS Deployment Group.
ILambdaApplication	Represents a reference to a CodeDeploy Application deploying to AWS Lambda.
ILambdaApplicationProps	Construction properties for {@link LambdaApplication}.
ILambdaDeploymentConfig	The Deployment Configuration of a Lambda Deployment Group.
ILambdaDeploymentConfigImportProps	Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
ILambdaDeploymentGroup	Interface for a Lambda deployment groups.
ILambdaDeploymentGroupAttributes	Properties of a reference to a CodeDeploy Lambda Deployment Group.
ILambdaDeploymentGroupProps	Construction properties for {@link LambdaDeploymentGroup}.
IServerApplication	Represents a reference to a CodeDeploy Application deploying to EC2/on-premise instances.
IServerApplicationProps	Construction properties for {@link ServerApplication}.
IServerDeploymentConfig	The Deployment Configuration of an EC2/on-premise Deployment Group.
IServerDeploymentConfigProps	Construction properties of {@link ServerDeploymentConfig}.
IServerDeploymentGroup
IServerDeploymentGroupAttributes	Properties of a reference to a CodeDeploy EC2/on-premise Deployment Group.
IServerDeploymentGroupProps	Construction properties for {@link ServerDeploymentGroup}.