@aws-cdk/aws-codedeploy

The CDK Construct Library for AWS CodeDeploy

Applications

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

import codedeploy = require('@aws-cdk/aws-codedeploy');

const application = new codedeploy.ServerApplication(this, 'CodeDeployApplication', {
    applicationName: 'MyApplication', // optional property
});

To import an already existing Application:

const application = codedeploy.ServerApplicationRef.import(this, 'ExistingCodeDeployApplication', {
    applicationName: 'MyExistingApplication',
});

Deployment Groups

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

const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'CodeDeployDeploymentGroup', {
    application,
    deploymentGroupName: 'MyDeploymentGroup',
    autoScalingGroups: [asg1, asg2],
    // 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 codedeploy.InstanceTagSet(
        {
            // any instance with tags satisfying
            // key1=v1 or key1=v2 or key2 (any value) or value v3 (any key)
            // will match this group
            'key1': ['v1', 'v2'],
            'key2': [],
            '': ['v3'],
        },
    ),
    // adds on-premise instances matching tags
    onPremiseInstanceTags: new codedeploy.InstanceTagSet(
        // only instances with tags (key1=v1 or key1=v2) AND key2=v3 will match this set
        {
            'key1': ['v1', 'v2'],
        },
        {
            'key2': ['v3'],
        },
    ),
    // CloudWatch alarms
    alarms: [
        new cloudwatch.Alarm(/* ... */),
    ],
    // whether to ignore failure to fetch the status of alarms from CloudWatch
    // default: false
    ignorePollAlarmsFailure: false,
    // auto-rollback configuration
    autoRollback: {
        failedDeployment: true, // default: true
        stoppedDeployment: true, // default: false
        deploymentInAlarm: true, // default: true if you provided any alarms, false otherwise
    },
});

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

To import an already existing Deployment Group:

const deploymentGroup = codedeploy.ServerDeploymentGroupRef.import(this, 'ExistingCodeDeployDeploymentGroup', {
    application,
    deploymentGroupName: 'MyExistingDeploymentGroup',
});

Load balancers

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

With Classic Elastic Load Balancer, you provide it directly:

import lb = require('@aws-cdk/aws-elasticloadbalancing');

const elb = new lb.LoadBalancer(this, 'ELB', {
    // ...
});
elb.addTarget(/* ... */);
elb.addListener({
    // ...
});

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

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

import lbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');

const alb = new lbv2.ApplicationLoadBalancer(this, 'ALB', {
    // ...
});
const listener = alb.addListener('Listener', {
    // ...
});
const targetGroup = listener.addTargets('Fleet', {
    // ...
});

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

Deployment Configurations

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

const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'CodeDeployDeploymentGroup', {
    deploymentConfig: codedeploy.ServerDeploymentConfig.AllAtOnce,
});

The default Deployment Configuration is ServerDeploymentConfig.OneAtATime.

You can also create a custom Deployment Configuration:

const deploymentConfig = new codedeploy.ServerDeploymentConfig(this, 'DeploymentConfiguration', {
    deploymentConfigName: 'MyDeploymentConfiguration', // optional property
    // one of these is required, but both cannot be specified at the same time
    minHealthyHostCount: 2,
    minHealthyHostPercentage: 75,
});

Or import an existing one:

const deploymentConfig = codedeploy.ServerDeploymentConfigRef.import(this, 'ExistingDeploymentConfiguration', {
    deploymentConfigName: 'MyExistingDeploymentConfiguration',
});

Use in CodePipeline

This module also contains an Action that allows you to use CodeDeploy with AWS CodePipeline.

Example:

import codepipeline = require('@aws-cdk/aws-codepipeline');

const pipeline = new codepipeline.Pipeline(this, 'MyPipeline', {
    pipelineName: 'MyPipeline',
});

// add the source and build Stages to the Pipeline...

const deployStage = pipeline.addStage('Deploy');
new codedeploy.PipelineDeployAction(this, 'CodeDeploy', {
    stage: deployStage,
    deploymentGroup,
});

You can also add the Deployment Group to the Pipeline directly:

// equivalent to the code above:
deploymentGroup.addToPipeline(deployStage, 'CodeDeploy');

Changelog

0.20.0 (2018-12-13)

Bug Fixes

• assert: Adjust assertion behavior to be stricter (#1289) (0919bf4), closes awslabs/cdk-ops#186
• aws-cdk: fix profile use in non-'aws' partitions (#1283) (5478913), closes #1262 #1109
• upgrade jsii to v0.7.12 (#1328) (62b7941)
• aws-cdk: fix YAML line wrapping issue (#1334) (48b9bdd), closes #1309
• aws-codecommit: make the onCommit CloudWatch Event respect creating the branch as well. (#1320) (cb1aed9)
• aws-ecr: add the addToPipeline method to IRepository. (#1329) (c4a9b74)
• aws-ecs: fix healthCheckGracePeriodSeconds (#1266) (3a89e21), closes #1265
• aws-ecs: set permissions for 'awslogs' log driver (#1291) (f5bc59b), closes #1279
• aws-lambda: code.asset now supports jar files, fixes #1294 (#1330) (3076070)
• aws-logs: set default log retention of LogGroup to 731 instead of 730 (#1344) (71dc09f), closes #1343

Features

• aws-cdk: directory assets follow symlinks (#1318) (2dfd593), closes #731
• aws-s3: orphan buckets by default (#1273) (2eb47ad), closes #1269
• core: include jsii runtime version in analytics (#1288) (f06de18), closes awslabs/jsii#325 #1258 awslabs/cdk-ops#127
• core: only include cdk libs in version reporting (#1290) (6184423), closes awslabs/cdk-ops#172
• docs: add design process description & basic style guide (#1229) (5ffa7e2), closes awslabs/cdk-ops#177
• toolkit: include toolkit version in AWS::CDK::Metadata (#1287) (5004f50), closes #1286

BREAKING CHANGES TO EXPERIMENTAL FEATURES

• assert: the behavior change of haveResource can cause tests to fail. If allowing extension of the expected values is the intended behavior, you can switch to the haveResourceLike matcher instead, which exposes the previous behavior.