This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-codedeploy

The CDK Construct Library for AWS CodeDeploy

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:

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.ServerApplication.import(this, 'ExistingCodeDeployApplication', {
    applicationName: 'MyExistingApplication',
});

EC2/on-premise 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.ServerDeploymentGroup.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.ServerDeploymentConfig.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 deployAction = new codedeploy.PipelineDeployAction({
  actionName: 'CodeDeploy',
  inputArtifact: buildAction.outputArtifact,
  deploymentGroup,
});
pipeline.addStage({
  name: 'Deploy',
  actions: [deployAction],
});

You can also create an action from the Deployment Group directly:

// equivalent to the code above:
const deployAction = deploymentGroup.toCodePipelineDeployAction({
  actionName: 'CodeDeploy',
  inputArtifact: buildAction.outputArtifact,
});

Lambda Applications

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

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

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

To import an already existing Application:

const application = codedeploy.LambdaApplication.import(this, 'ExistingCodeDeployApplication', {
    applicationName: '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:

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

const myApplication = new codedeploy.LambdaApplication(..);
const func = new lambda.Function(..);
const version = func.addVersion('1');
const version1Alias = new lambda.Alias(this, 'alias', {
  aliasName: 'prod',
  version
});

const deploymentGroup = new codedeploy.LambdaDeploymentGroup(stack, 'BlueGreenDeployment', {
  application: myApplication, // optional property: one will be created for you if not provided
  alias: version1Alias,
  deploymentConfig: codedeploy.LambdaDeploymentConfig.Linear10PercentEvery1Minute,
});

In order to deploy a new version of this function:

  1. Increment the version, e.g. const version = func.addVersion('2').
  2. Re-deploy the stack (this will trigger a deployment).
  3. Monitor the CodeDeploy deployment as traffic shifts between the versions.

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:

const deploymentGroup = new codedeploy.LambdaDeploymentGroup(stack, 'BlueGreenDeployment', {
  alias,
  deploymentConfig: codedeploy.LambdaDeploymentConfig.Linear10PercentEvery1Minute,
  alarms: [
    // pass some alarms when constructing the deployment group
    new cloudwatch.Alarm(stack, 'Errors', {
      comparisonOperator: cloudwatch.ComparisonOperator.GreaterThanThreshold,
      threshold: 1,
      evaluationPeriods: 1,
      metric: alias.metricErrors()
    })
  ]
});

// or add alarms to an existing group
deploymentGroup.addAlarm(new cloudwatch.Alarm(stack, 'BlueGreenErrors', {
  comparisonOperator: cloudwatch.ComparisonOperator.GreaterThanThreshold,
  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.

const warmUpUserCache = new lambda.Function(..);
const endToEndValidation = new lambda.Function(..);

// pass a hook whe creating the deployment group
const deploymentGroup = new codedeploy.LambdaDeploymentGroup(stack, 'BlueGreenDeployment', {
  alias: alias,
  deploymentConfig: codedeploy.LambdaDeploymentConfig.Linear10PercentEvery1Minute,
  preHook: warmUpUserCache,
});

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

Import an existing Deployment Group

To import an already existing Deployment Group:

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

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.CodeDeploy" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.CodeDeploy --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.CodeDeploy" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:codedeploy:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="codedeploy" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>codedeploy</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:codedeploy:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='codedeploy', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-codedeploy@0.25.3

package.json:

{
  "@aws-cdk/aws-codedeploy": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-codedeploy@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-codedeploy@0.25.3

package.json:

{
  "@aws-cdk/aws-codedeploy": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-codedeploy@0.25.3

AutoRollbackConfig (interface)

class @aws-cdk/aws-codedeploy.AutoRollbackConfig

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.AutoRollbackConfig;
// AutoRollbackConfig is an interface
import { AutoRollbackConfig } from '@aws-cdk/aws-codedeploy';

The configuration for automatically rolling back deployments in a given Deployment Group.

deploymentInAlarm

Whether to automatically roll back a deployment during which one of the configured

CloudWatch alarms for this Deployment Group went off.

Type:boolean (optional)
Default:true if you’ve provided any Alarms with the alarms property, false otherwise
failedDeployment

Whether to automatically roll back a deployment that fails.

Type:boolean (optional)
Default:true
stoppedDeployment

Whether to automatically roll back a deployment that was manually stopped.

Type:boolean (optional)
Default:false

CfnApplication

class @aws-cdk/aws-codedeploy.CfnApplication(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnApplication;
const { CfnApplication } = require('@aws-cdk/aws-codedeploy');
import { CfnApplication } from '@aws-cdk/aws-codedeploy';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
applicationName
Type:string (readonly)
propertyOverrides
Type:CfnApplicationProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnApplicationProps (interface)

class @aws-cdk/aws-codedeploy.CfnApplicationProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnApplicationProps;
// CfnApplicationProps is an interface
import { CfnApplicationProps } from '@aws-cdk/aws-codedeploy';
applicationName

AWS::CodeDeploy::Application.ApplicationName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-applicationname

Type:string (optional)
computePlatform

AWS::CodeDeploy::Application.ComputePlatform

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-computeplatform

Type:string (optional)

CfnDeploymentConfig

class @aws-cdk/aws-codedeploy.CfnDeploymentConfig(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig;
const { CfnDeploymentConfig } = require('@aws-cdk/aws-codedeploy');
import { CfnDeploymentConfig } from '@aws-cdk/aws-codedeploy';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
deploymentConfigId
Type:string (readonly)
propertyOverrides
Type:CfnDeploymentConfigProps (readonly)
class MinimumHealthyHostsProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig.MinimumHealthyHostsProperty;
// CfnDeploymentConfig.MinimumHealthyHostsProperty is an interface
import { CfnDeploymentConfig.MinimumHealthyHostsProperty } from '@aws-cdk/aws-codedeploy';
type

CfnDeploymentConfig.MinimumHealthyHostsProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-type

Type:string
value

CfnDeploymentConfig.MinimumHealthyHostsProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-value

Type:number or @aws-cdk/cdk.Token
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDeploymentConfigProps (interface)

class @aws-cdk/aws-codedeploy.CfnDeploymentConfigProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentConfigProps;
// CfnDeploymentConfigProps is an interface
import { CfnDeploymentConfigProps } from '@aws-cdk/aws-codedeploy';
deploymentConfigName

AWS::CodeDeploy::DeploymentConfig.DeploymentConfigName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname

Type:string (optional)
minimumHealthyHosts

AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts

Type:MinimumHealthyHostsProperty or @aws-cdk/cdk.Token (optional)

CfnDeploymentGroup

class @aws-cdk/aws-codedeploy.CfnDeploymentGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup;
const { CfnDeploymentGroup } = require('@aws-cdk/aws-codedeploy');
import { CfnDeploymentGroup } from '@aws-cdk/aws-codedeploy';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
deploymentGroupName
Type:string (readonly)
propertyOverrides
Type:CfnDeploymentGroupProps (readonly)
class AlarmConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty;
// CfnDeploymentGroup.AlarmConfigurationProperty is an interface
import { CfnDeploymentGroup.AlarmConfigurationProperty } from '@aws-cdk/aws-codedeploy';
alarms

CfnDeploymentGroup.AlarmConfigurationProperty.Alarms

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or AlarmProperty)[] (optional)
enabled

CfnDeploymentGroup.AlarmConfigurationProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
ignorePollAlarmFailure

CfnDeploymentGroup.AlarmConfigurationProperty.IgnorePollAlarmFailure

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure

Type:boolean or @aws-cdk/cdk.Token (optional)
class AlarmProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.AlarmProperty;
// CfnDeploymentGroup.AlarmProperty is an interface
import { CfnDeploymentGroup.AlarmProperty } from '@aws-cdk/aws-codedeploy';
name

CfnDeploymentGroup.AlarmProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html#cfn-codedeploy-deploymentgroup-alarm-name

Type:string (optional)
class AutoRollbackConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty;
// CfnDeploymentGroup.AutoRollbackConfigurationProperty is an interface
import { CfnDeploymentGroup.AutoRollbackConfigurationProperty } from '@aws-cdk/aws-codedeploy';
enabled

CfnDeploymentGroup.AutoRollbackConfigurationProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
events

CfnDeploymentGroup.AutoRollbackConfigurationProperty.Events

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-events

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class DeploymentProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.DeploymentProperty;
// CfnDeploymentGroup.DeploymentProperty is an interface
import { CfnDeploymentGroup.DeploymentProperty } from '@aws-cdk/aws-codedeploy';
revision

CfnDeploymentGroup.DeploymentProperty.Revision

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision

Type:@aws-cdk/cdk.Token or RevisionLocationProperty
description

CfnDeploymentGroup.DeploymentProperty.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-description

Type:string (optional)
ignoreApplicationStopFailures

CfnDeploymentGroup.DeploymentProperty.IgnoreApplicationStopFailures

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures

Type:boolean or @aws-cdk/cdk.Token (optional)
class DeploymentStyleProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.DeploymentStyleProperty;
// CfnDeploymentGroup.DeploymentStyleProperty is an interface
import { CfnDeploymentGroup.DeploymentStyleProperty } from '@aws-cdk/aws-codedeploy';
deploymentOption

CfnDeploymentGroup.DeploymentStyleProperty.DeploymentOption

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption

Type:string (optional)
deploymentType

CfnDeploymentGroup.DeploymentStyleProperty.DeploymentType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymenttype

Type:string (optional)
class EC2TagFilterProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.EC2TagFilterProperty;
// CfnDeploymentGroup.EC2TagFilterProperty is an interface
import { CfnDeploymentGroup.EC2TagFilterProperty } from '@aws-cdk/aws-codedeploy';
key

CfnDeploymentGroup.EC2TagFilterProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-key

Type:string (optional)
type

CfnDeploymentGroup.EC2TagFilterProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-type

Type:string (optional)
value

CfnDeploymentGroup.EC2TagFilterProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-value

Type:string (optional)
class EC2TagSetListObjectProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.EC2TagSetListObjectProperty;
// CfnDeploymentGroup.EC2TagSetListObjectProperty is an interface
import { CfnDeploymentGroup.EC2TagSetListObjectProperty } from '@aws-cdk/aws-codedeploy';
ec2TagGroup

CfnDeploymentGroup.EC2TagSetListObjectProperty.Ec2TagGroup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html#cfn-codedeploy-deploymentgroup-ec2tagsetlistobject-ec2taggroup

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EC2TagFilterProperty)[] (optional)
class EC2TagSetProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.EC2TagSetProperty;
// CfnDeploymentGroup.EC2TagSetProperty is an interface
import { CfnDeploymentGroup.EC2TagSetProperty } from '@aws-cdk/aws-codedeploy';
ec2TagSetList

CfnDeploymentGroup.EC2TagSetProperty.Ec2TagSetList

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html#cfn-codedeploy-deploymentgroup-ec2tagset-ec2tagsetlist

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EC2TagSetListObjectProperty)[] (optional)
class ELBInfoProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.ELBInfoProperty;
// CfnDeploymentGroup.ELBInfoProperty is an interface
import { CfnDeploymentGroup.ELBInfoProperty } from '@aws-cdk/aws-codedeploy';
name

CfnDeploymentGroup.ELBInfoProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html#cfn-codedeploy-deploymentgroup-elbinfo-name

Type:string (optional)
class GitHubLocationProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.GitHubLocationProperty;
// CfnDeploymentGroup.GitHubLocationProperty is an interface
import { CfnDeploymentGroup.GitHubLocationProperty } from '@aws-cdk/aws-codedeploy';
commitId

CfnDeploymentGroup.GitHubLocationProperty.CommitId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-commitid

Type:string
repository

CfnDeploymentGroup.GitHubLocationProperty.Repository

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-repository

Type:string
class LoadBalancerInfoProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty;
// CfnDeploymentGroup.LoadBalancerInfoProperty is an interface
import { CfnDeploymentGroup.LoadBalancerInfoProperty } from '@aws-cdk/aws-codedeploy';
elbInfoList

CfnDeploymentGroup.LoadBalancerInfoProperty.ElbInfoList

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ELBInfoProperty)[] (optional)
targetGroupInfoList

CfnDeploymentGroup.LoadBalancerInfoProperty.TargetGroupInfoList

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetGroupInfoProperty)[] (optional)
class OnPremisesTagSetListObjectProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.OnPremisesTagSetListObjectProperty;
// CfnDeploymentGroup.OnPremisesTagSetListObjectProperty is an interface
import { CfnDeploymentGroup.OnPremisesTagSetListObjectProperty } from '@aws-cdk/aws-codedeploy';
onPremisesTagGroup

CfnDeploymentGroup.OnPremisesTagSetListObjectProperty.OnPremisesTagGroup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html#cfn-codedeploy-deploymentgroup-onpremisestagsetlistobject-onpremisestaggroup

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagFilterProperty)[] (optional)
class OnPremisesTagSetProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.OnPremisesTagSetProperty;
// CfnDeploymentGroup.OnPremisesTagSetProperty is an interface
import { CfnDeploymentGroup.OnPremisesTagSetProperty } from '@aws-cdk/aws-codedeploy';
onPremisesTagSetList

CfnDeploymentGroup.OnPremisesTagSetProperty.OnPremisesTagSetList

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html#cfn-codedeploy-deploymentgroup-onpremisestagset-onpremisestagsetlist

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or OnPremisesTagSetListObjectProperty)[] (optional)
class RevisionLocationProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.RevisionLocationProperty;
// CfnDeploymentGroup.RevisionLocationProperty is an interface
import { CfnDeploymentGroup.RevisionLocationProperty } from '@aws-cdk/aws-codedeploy';
gitHubLocation

CfnDeploymentGroup.RevisionLocationProperty.GitHubLocation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation

Type:@aws-cdk/cdk.Token or GitHubLocationProperty (optional)
revisionType

CfnDeploymentGroup.RevisionLocationProperty.RevisionType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-revisiontype

Type:string (optional)
s3Location

CfnDeploymentGroup.RevisionLocationProperty.S3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location

Type:@aws-cdk/cdk.Token or S3LocationProperty (optional)
class S3LocationProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.S3LocationProperty;
// CfnDeploymentGroup.S3LocationProperty is an interface
import { CfnDeploymentGroup.S3LocationProperty } from '@aws-cdk/aws-codedeploy';
bucket

CfnDeploymentGroup.S3LocationProperty.Bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bucket

Type:string
key

CfnDeploymentGroup.S3LocationProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-key

Type:string
bundleType

CfnDeploymentGroup.S3LocationProperty.BundleType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bundletype

Type:string (optional)
eTag

CfnDeploymentGroup.S3LocationProperty.ETag

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-etag

Type:string (optional)
version

CfnDeploymentGroup.S3LocationProperty.Version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-value

Type:string (optional)
class TagFilterProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.TagFilterProperty;
// CfnDeploymentGroup.TagFilterProperty is an interface
import { CfnDeploymentGroup.TagFilterProperty } from '@aws-cdk/aws-codedeploy';
key

CfnDeploymentGroup.TagFilterProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-key

Type:string (optional)
type

CfnDeploymentGroup.TagFilterProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-type

Type:string (optional)
value

CfnDeploymentGroup.TagFilterProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-value

Type:string (optional)
class TargetGroupInfoProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty;
// CfnDeploymentGroup.TargetGroupInfoProperty is an interface
import { CfnDeploymentGroup.TargetGroupInfoProperty } from '@aws-cdk/aws-codedeploy';
name

CfnDeploymentGroup.TargetGroupInfoProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html#cfn-codedeploy-deploymentgroup-targetgroupinfo-name

Type:string (optional)
class TriggerConfigProperty

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.TriggerConfigProperty;
// CfnDeploymentGroup.TriggerConfigProperty is an interface
import { CfnDeploymentGroup.TriggerConfigProperty } from '@aws-cdk/aws-codedeploy';
triggerEvents

CfnDeploymentGroup.TriggerConfigProperty.TriggerEvents

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggerevents

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
triggerName

CfnDeploymentGroup.TriggerConfigProperty.TriggerName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggername

Type:string (optional)
triggerTargetArn

CfnDeploymentGroup.TriggerConfigProperty.TriggerTargetArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggertargetarn

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDeploymentGroupProps (interface)

class @aws-cdk/aws-codedeploy.CfnDeploymentGroupProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CfnDeploymentGroupProps;
// CfnDeploymentGroupProps is an interface
import { CfnDeploymentGroupProps } from '@aws-cdk/aws-codedeploy';
applicationName

AWS::CodeDeploy::DeploymentGroup.ApplicationName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-applicationname

Type:string
serviceRoleArn

AWS::CodeDeploy::DeploymentGroup.ServiceRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-servicerolearn

Type:string
alarmConfiguration

AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-alarmconfiguration

Type:@aws-cdk/cdk.Token or AlarmConfigurationProperty (optional)
autoRollbackConfiguration

AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration

Type:@aws-cdk/cdk.Token or AutoRollbackConfigurationProperty (optional)
autoScalingGroups

AWS::CodeDeploy::DeploymentGroup.AutoScalingGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autoscalinggroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
deployment

AWS::CodeDeploy::DeploymentGroup.Deployment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deployment

Type:@aws-cdk/cdk.Token or DeploymentProperty (optional)
deploymentConfigName

AWS::CodeDeploy::DeploymentGroup.DeploymentConfigName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname

Type:string (optional)
deploymentGroupName

AWS::CodeDeploy::DeploymentGroup.DeploymentGroupName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentgroupname

Type:string (optional)
deploymentStyle

AWS::CodeDeploy::DeploymentGroup.DeploymentStyle

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentstyle

Type:@aws-cdk/cdk.Token or DeploymentStyleProperty (optional)
ec2TagFilters

AWS::CodeDeploy::DeploymentGroup.Ec2TagFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagfilters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EC2TagFilterProperty)[] (optional)
ec2TagSet

AWS::CodeDeploy::DeploymentGroup.Ec2TagSet

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagset

Type:@aws-cdk/cdk.Token or EC2TagSetProperty (optional)
loadBalancerInfo

AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo

Type:@aws-cdk/cdk.Token or LoadBalancerInfoProperty (optional)
onPremisesInstanceTagFilters

AWS::CodeDeploy::DeploymentGroup.OnPremisesInstanceTagFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisesinstancetagfilters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagFilterProperty)[] (optional)
onPremisesTagSet

AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisestagset

Type:@aws-cdk/cdk.Token or OnPremisesTagSetProperty (optional)
triggerConfigurations

AWS::CodeDeploy::DeploymentGroup.TriggerConfigurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TriggerConfigProperty)[] (optional)

CommonPipelineDeployActionProps (interface)

class @aws-cdk/aws-codedeploy.CommonPipelineDeployActionProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.CommonPipelineDeployActionProps;
// CommonPipelineDeployActionProps is an interface
import { CommonPipelineDeployActionProps } from '@aws-cdk/aws-codedeploy';

Common properties for creating a {@link PipelineDeployAction},

either directly, through its constructor,

or through {@link IServerDeploymentGroup#toCodePipelineDeployAction}.

Extends:@aws-cdk/aws-codepipeline-api.CommonActionProps
inputArtifact

The source to use as input for deployment.

Type:@aws-cdk/aws-codepipeline-api.Artifact
actionName

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional)
Default:1

ILambdaApplication (interface)

class @aws-cdk/aws-codedeploy.ILambdaApplication

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ILambdaApplication;
// ILambdaApplication is an interface
import { ILambdaApplication } from '@aws-cdk/aws-codedeploy';

Represents a reference to a CodeDeploy Application deploying to AWS Lambda.

If you’re managing the Application alongside the rest of your CDK resources,

use the {@link LambdaApplication} class.

If you want to reference an already existing Application,

or one defined in a different CDK Stack,

use the {@link LambdaApplication#import} method.

Extends:@aws-cdk/cdk.IConstruct
applicationArn
Type:string (readonly)
applicationName
Type:string (readonly)
export() → @aws-cdk/aws-codedeploy.LambdaApplicationImportProps
Return type:LambdaApplicationImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

ILambdaDeploymentConfig (interface)

class @aws-cdk/aws-codedeploy.ILambdaDeploymentConfig

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ILambdaDeploymentConfig;
// ILambdaDeploymentConfig is an interface
import { ILambdaDeploymentConfig } from '@aws-cdk/aws-codedeploy';

The Deployment Configuration of a Lambda Deployment Group.

The default, pre-defined Configurations are available as constants on the {@link LambdaDeploymentConfig} class

(LambdaDeploymentConfig.AllAtOnce, LambdaDeploymentConfig.Canary10Percent30Minutes, etc.).

Note: CloudFormation does not currently support creating custom lambda configs outside

of using a custom resource. You can import custom deployment config created outside the

CDK or via a custom resource with {@link LambdaDeploymentConfig#import}.

deploymentConfigName
Type:string (readonly)
deploymentConfigArn(scope) → string
Parameters:scope (@aws-cdk/cdk.IConstruct) –
Return type:string
Abstract:Yes

ILambdaDeploymentGroup (interface)

class @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ILambdaDeploymentGroup;
// ILambdaDeploymentGroup is an interface
import { ILambdaDeploymentGroup } from '@aws-cdk/aws-codedeploy';

Interface for a Lambda deployment groups.

Extends:@aws-cdk/cdk.IConstruct
application

The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Type:ILambdaApplication (readonly)
deploymentGroupArn

The ARN of this Deployment Group.

Type:string (readonly)
deploymentGroupName

The physical name of the CodeDeploy Deployment Group.

Type:string (readonly)
export() → @aws-cdk/aws-codedeploy.LambdaDeploymentGroupImportProps

Export this Deployment Group for use in another stack or application.

Return type:LambdaDeploymentGroupImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IServerApplication (interface)

class @aws-cdk/aws-codedeploy.IServerApplication

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.IServerApplication;
// IServerApplication is an interface
import { IServerApplication } from '@aws-cdk/aws-codedeploy';

Represents a reference to a CodeDeploy Application deploying to EC2/on-premise instances.

If you’re managing the Application alongside the rest of your CDK resources,

use the {@link ServerApplication} class.

If you want to reference an already existing Application,

or one defined in a different CDK Stack,

use the {@link #import} method.

Extends:@aws-cdk/cdk.IConstruct
applicationArn
Type:string (readonly)
applicationName
Type:string (readonly)
export() → @aws-cdk/aws-codedeploy.ServerApplicationImportProps
Return type:ServerApplicationImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IServerDeploymentConfig (interface)

class @aws-cdk/aws-codedeploy.IServerDeploymentConfig

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.IServerDeploymentConfig;
// IServerDeploymentConfig is an interface
import { IServerDeploymentConfig } from '@aws-cdk/aws-codedeploy';

The Deployment Configuration of an EC2/on-premise Deployment Group.

The default, pre-defined Configurations are available as constants on the {@link ServerDeploymentConfig} class

(ServerDeploymentConfig.HalfAtATime, ServerDeploymentConfig.AllAtOnce, etc.).

To create a custom Deployment Configuration,

instantiate the {@link ServerDeploymentConfig} Construct.

deploymentConfigName
Type:string (readonly)
deploymentConfigArn(scope) → string
Parameters:scope (@aws-cdk/cdk.IConstruct) –
Return type:string
Abstract:Yes
export() → @aws-cdk/aws-codedeploy.ServerDeploymentConfigImportProps
Return type:ServerDeploymentConfigImportProps
Abstract:Yes

IServerDeploymentGroup (interface)

class @aws-cdk/aws-codedeploy.IServerDeploymentGroup

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.IServerDeploymentGroup;
// IServerDeploymentGroup is an interface
import { IServerDeploymentGroup } from '@aws-cdk/aws-codedeploy';
Extends:@aws-cdk/cdk.IConstruct
application
Type:IServerApplication (readonly)
deploymentConfig
Type:IServerDeploymentConfig (readonly)
deploymentGroupArn
Type:string (readonly)
deploymentGroupName
Type:string (readonly)
autoScalingGroups
Type:@aws-cdk/aws-autoscaling.AutoScalingGroup[] (optional) (readonly)
role
Type:@aws-cdk/aws-iam.Role (optional) (readonly)
export() → @aws-cdk/aws-codedeploy.ServerDeploymentGroupImportProps
Return type:ServerDeploymentGroupImportProps
Abstract:Yes
toCodePipelineDeployAction(props) → @aws-cdk/aws-codedeploy.PipelineDeployAction

Convenience method for creating a new {@link PipelineDeployAction}.

Parameters:props (CommonPipelineDeployActionProps) – the construction properties of the new Action
Returns:the newly created {@link PipelineDeployAction}
Return type:PipelineDeployAction
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

InstanceTagSet

class @aws-cdk/aws-codedeploy.InstanceTagSet(*instanceTagGroups)

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.InstanceTagSet;
const { InstanceTagSet } = require('@aws-cdk/aws-codedeploy');
import { InstanceTagSet } from '@aws-cdk/aws-codedeploy';

Represents a set of instance tag groups.

An instance will match a set if it matches all of the groups in the set -

in other words, sets follow ‘and’ semantics.

You can have a maximum of 3 tag groups inside a set.

Parameters:*instanceTagGroups (string => string[]) –
instanceTagGroups
Type:string => string[][] (readonly)

LambdaApplication

class @aws-cdk/aws-codedeploy.LambdaApplication(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaApplication;
const { LambdaApplication } = require('@aws-cdk/aws-codedeploy');
import { LambdaApplication } from '@aws-cdk/aws-codedeploy';

A CodeDeploy Application that deploys to an AWS Lambda function.

Extends:

@aws-cdk/cdk.Construct

Implements:

ILambdaApplication

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codedeploy.ILambdaApplication

Import an Application defined either outside the CDK,

or in a different CDK Stack and exported using the {@link ILambdaApplication#export} method.

Parameters:
Returns:

a Construct representing a reference to an existing Application

Return type:

ILambdaApplication

export() → @aws-cdk/aws-codedeploy.LambdaApplicationImportProps

Implements @aws-cdk/aws-codedeploy.ILambdaApplication.export()

Return type:LambdaApplicationImportProps
applicationArn

Implements @aws-cdk/aws-codedeploy.ILambdaApplication.applicationArn()

Type:string (readonly)
applicationName

Implements @aws-cdk/aws-codedeploy.ILambdaApplication.applicationName()

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

LambdaApplicationImportProps (interface)

class @aws-cdk/aws-codedeploy.LambdaApplicationImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaApplicationImportProps;
// LambdaApplicationImportProps is an interface
import { LambdaApplicationImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy Application.

applicationName

The physical, human-readable name of the Lambda Application we’re referencing.

The Application must be in the same account and region as the root Stack.

Type:string

LambdaApplicationProps (interface)

class @aws-cdk/aws-codedeploy.LambdaApplicationProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaApplicationProps;
// LambdaApplicationProps is an interface
import { LambdaApplicationProps } from '@aws-cdk/aws-codedeploy';

Construction properties for {@link LambdaApplication}.

applicationName

The physical, human-readable name of the CodeDeploy Application.

Type:string (optional)
Default:an auto-generated name will be used

LambdaDeploymentConfig

class @aws-cdk/aws-codedeploy.LambdaDeploymentConfig

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaDeploymentConfig;
const { LambdaDeploymentConfig } = require('@aws-cdk/aws-codedeploy');
import { LambdaDeploymentConfig } from '@aws-cdk/aws-codedeploy';

A custom Deployment Configuration for a Lambda Deployment Group.

Note: This class currently stands as namespaced container of the default configurations

until CloudFormation supports custom Lambda Deployment Configs. Until then it is closed

(private constructor) and does not extend {@link cdk.Construct}

static import(scope, id, props) → @aws-cdk/aws-codedeploy.ILambdaDeploymentConfig

Import a custom Deployment Configuration for a Lambda Deployment Group defined outside the CDK.

Parameters:
Returns:

a Construct representing a reference to an existing custom Deployment Configuration

Return type:

ILambdaDeploymentConfig

AllAtOnce
Type:ILambdaDeploymentConfig (readonly) (static)
Canary10Percent10Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Canary10Percent15Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Canary10Percent30Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Canary10Percent5Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Linear10PercentEvery10Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Linear10PercentEvery1Minute
Type:ILambdaDeploymentConfig (readonly) (static)
Linear10PercentEvery2Minutes
Type:ILambdaDeploymentConfig (readonly) (static)
Linear10PercentEvery3Minutes
Type:ILambdaDeploymentConfig (readonly) (static)

LambdaDeploymentConfigImportProps (interface)

class @aws-cdk/aws-codedeploy.LambdaDeploymentConfigImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaDeploymentConfigImportProps;
// LambdaDeploymentConfigImportProps is an interface
import { LambdaDeploymentConfigImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy Lambda Deployment Configuration.

deploymentConfigName

The physical, human-readable name of the custom CodeDeploy Lambda Deployment Configuration

that we are referencing.

Type:string

LambdaDeploymentGroup

class @aws-cdk/aws-codedeploy.LambdaDeploymentGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaDeploymentGroup;
const { LambdaDeploymentGroup } = require('@aws-cdk/aws-codedeploy');
import { LambdaDeploymentGroup } from '@aws-cdk/aws-codedeploy';
Extends:

@aws-cdk/cdk.Construct

Implements:

ILambdaDeploymentGroup

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup

Import an Lambda Deployment Group defined either outside the CDK,

or in a different CDK Stack and exported using the {@link #export} method.

Parameters:
Returns:

a Construct representing a reference to an existing Deployment Group

Return type:

ILambdaDeploymentGroup

addAlarm(alarm)

Associates an additional alarm with this Deployment Group.

Parameters:alarm (@aws-cdk/aws-cloudwatch.Alarm) – the alarm to associate with this Deployment Group
export() → @aws-cdk/aws-codedeploy.LambdaDeploymentGroupImportProps

Implements @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup.export()

Export this Deployment Group for use in another stack or application.

Return type:LambdaDeploymentGroupImportProps
grantPutLifecycleEventHookExecutionStatus([principal])

Grant a principal permission to codedeploy:PutLifecycleEventHookExecutionStatus

on this deployment group resource.

Parameters:principal (@aws-cdk/aws-iam.IPrincipal (optional)) – to grant permission to
onPostHook(postHook)

Associate a function to run after deployment completes.

Parameters:postHook (@aws-cdk/aws-lambda.IFunction) –
onPreHook(preHook)

Associate a function to run before deployment begins.

Parameters:preHook (@aws-cdk/aws-lambda.IFunction) – function to run before deployment beings
application

Implements @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup.application()

The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Type:ILambdaApplication (readonly)
deploymentGroupArn

Implements @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup.deploymentGroupArn()

The ARN of this Deployment Group.

Type:string (readonly)
deploymentGroupName

Implements @aws-cdk/aws-codedeploy.ILambdaDeploymentGroup.deploymentGroupName()

The physical name of the CodeDeploy Deployment Group.

Type:string (readonly)
role
Type:@aws-cdk/aws-iam.IRole (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

LambdaDeploymentGroupImportProps (interface)

class @aws-cdk/aws-codedeploy.LambdaDeploymentGroupImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaDeploymentGroupImportProps;
// LambdaDeploymentGroupImportProps is an interface
import { LambdaDeploymentGroupImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy Lambda Deployment Group.

application

The reference to the CodeDeploy Lambda Application

that this Deployment Group belongs to.

Type:ILambdaApplication
deploymentGroupName

The physical, human-readable name of the CodeDeploy Lambda Deployment Group

that we are referencing.

Type:string

LambdaDeploymentGroupProps (interface)

class @aws-cdk/aws-codedeploy.LambdaDeploymentGroupProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.LambdaDeploymentGroupProps;
// LambdaDeploymentGroupProps is an interface
import { LambdaDeploymentGroupProps } from '@aws-cdk/aws-codedeploy';

Construction properties for {@link LambdaDeploymentGroup}.

alias

Lambda Alias to shift traffic. Updating the version

of the alias will trigger a CodeDeploy deployment.

Type:@aws-cdk/aws-lambda.Alias
alarms

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.

Type:@aws-cdk/aws-cloudwatch.Alarm[] (optional)
Default:[]
application

The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Type:ILambdaApplication (optional)
Default:one will be created for you
autoRollback

The auto-rollback configuration for this Deployment Group.

Type:AutoRollbackConfig (optional)
deploymentConfig

The Deployment Configuration this Deployment Group uses.

Type:ILambdaDeploymentConfig (optional)
Default:LambdaDeploymentConfig#AllAtOnce
deploymentGroupName

The physical, human-readable name of the CodeDeploy Deployment Group.

Type:string (optional)
Default:an auto-generated name will be used
ignorePollAlarmsFailure

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Type:boolean (optional)
Default:false
postHook

The Lambda function to run after traffic routing starts.

Type:@aws-cdk/aws-lambda.IFunction (optional)
preHook

The Lambda function to run before traffic routing starts.

Type:@aws-cdk/aws-lambda.IFunction (optional)
role

The service Role of this Deployment Group.

Type:@aws-cdk/aws-iam.IRole (optional)
Default:a new Role will be created.

PipelineDeployAction

class @aws-cdk/aws-codedeploy.PipelineDeployAction(props)

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.PipelineDeployAction;
const { PipelineDeployAction } = require('@aws-cdk/aws-codedeploy');
import { PipelineDeployAction } from '@aws-cdk/aws-codedeploy';
Extends:@aws-cdk/aws-codepipeline-api.DeployAction
Parameters:props (PipelineDeployActionProps) –
bind(stage, scope)

Implements @aws-cdk/aws-codepipeline-api.Action.bind()

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

Protected method

Parameters:
addInputArtifact(artifact) → @aws-cdk/aws-codepipeline-api.Action

Inherited from @aws-cdk/aws-codepipeline-api.Action

Protected method

Parameters:artifact (@aws-cdk/aws-codepipeline-api.Artifact) –
Return type:@aws-cdk/aws-codepipeline-api.Action
addOutputArtifact(name) → @aws-cdk/aws-codepipeline-api.Artifact

Inherited from @aws-cdk/aws-codepipeline-api.Action

Protected method

Parameters:name (string) –
Return type:@aws-cdk/aws-codepipeline-api.Artifact
onStateChange(name[, target[, options]]) → @aws-cdk/aws-events.EventRule

Inherited from @aws-cdk/aws-codepipeline-api.Action

Parameters:
Return type:

@aws-cdk/aws-events.EventRule

validate() → string[]

Inherited from @aws-cdk/aws-codepipeline-api.Action

Protected method

Return type:string[]
actionName

Inherited from @aws-cdk/aws-codepipeline-api.Action

Type:string (readonly)
category

Inherited from @aws-cdk/aws-codepipeline-api.Action

The category of the action.

The category defines which action type the owner

(the entity that performs the action) performs.

Type:@aws-cdk/aws-codepipeline-api.ActionCategory (readonly)
owner

Inherited from @aws-cdk/aws-codepipeline-api.Action

Type:string (readonly)
provider

Inherited from @aws-cdk/aws-codepipeline-api.Action

The service provider that the action calls.

Type:string (readonly)
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.Action

The order in which AWS CodePipeline runs this action.

For more information, see the AWS CodePipeline User Guide.

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

Type:number (readonly)
scope

Inherited from @aws-cdk/aws-codepipeline-api.Action

Retrieves the Construct scope of this Action.

Only available after the Action has been added to a Stage,

and that Stage to a Pipeline.

Protected property

Type:@aws-cdk/cdk.Construct (readonly)
version

Inherited from @aws-cdk/aws-codepipeline-api.Action

Type:string (readonly)
configuration

Inherited from @aws-cdk/aws-codepipeline-api.Action

The action’s configuration. These are key-value pairs that specify input values for an action.

For more information, see the AWS CodePipeline User Guide.

http://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

Type:any (optional) (readonly)
region

Inherited from @aws-cdk/aws-codepipeline-api.Action

The AWS region the given Action resides in.

Note that a cross-region Pipeline requires replication buckets to function correctly.

You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property.

If you don’t, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets,

that you will need to cdk deploy before deploying the main, Pipeline-containing Stack.

Type:string (optional) (readonly)
Default:the Action resides in the same region as the Pipeline
role

Inherited from @aws-cdk/aws-codepipeline-api.Action

The service role that is assumed during execution of action.

This role is not mandatory, however more advanced configuration

may require specifying it.

Type:@aws-cdk/aws-iam.IRole (optional) (readonly)

PipelineDeployActionProps (interface)

class @aws-cdk/aws-codedeploy.PipelineDeployActionProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.PipelineDeployActionProps;
// PipelineDeployActionProps is an interface
import { PipelineDeployActionProps } from '@aws-cdk/aws-codedeploy';

Construction properties of the {@link PipelineDeployAction CodeDeploy deploy CodePipeline Action}.

Extends:CommonPipelineDeployActionProps
deploymentGroup

The CodeDeploy Deployment Group to deploy to.

Type:IServerDeploymentGroup
inputArtifact

Inherited from @aws-cdk/aws-codedeploy.CommonPipelineDeployActionProps

The source to use as input for deployment.

Type:@aws-cdk/aws-codepipeline-api.Artifact
actionName

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionProps

The physical, human-readable name of the Action.

Not that Action names must be unique within a single Stage.

Type:string
runOrder

Inherited from @aws-cdk/aws-codepipeline-api.CommonActionProps

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Type:number (optional)
Default:1

ServerApplication

class @aws-cdk/aws-codedeploy.ServerApplication(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerApplication;
const { ServerApplication } = require('@aws-cdk/aws-codedeploy');
import { ServerApplication } from '@aws-cdk/aws-codedeploy';

A CodeDeploy Application that deploys to EC2/on-premise instances.

Extends:

@aws-cdk/cdk.Construct

Implements:

IServerApplication

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codedeploy.IServerApplication

Import an Application defined either outside the CDK,

or in a different CDK Stack and exported using the {@link #export} method.

Parameters:
Returns:

a Construct representing a reference to an existing Application

Return type:

IServerApplication

export() → @aws-cdk/aws-codedeploy.ServerApplicationImportProps

Implements @aws-cdk/aws-codedeploy.IServerApplication.export()

Return type:ServerApplicationImportProps
applicationArn

Implements @aws-cdk/aws-codedeploy.IServerApplication.applicationArn()

Type:string (readonly)
applicationName

Implements @aws-cdk/aws-codedeploy.IServerApplication.applicationName()

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ServerApplicationImportProps (interface)

class @aws-cdk/aws-codedeploy.ServerApplicationImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerApplicationImportProps;
// ServerApplicationImportProps is an interface
import { ServerApplicationImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy EC2/on-premise Application.

applicationName

The physical, human-readable name of the CodeDeploy EC2/on-premise Application we’re referencing.

The Application must be in the same account and region as the root Stack.

Type:string

ServerApplicationProps (interface)

class @aws-cdk/aws-codedeploy.ServerApplicationProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerApplicationProps;
// ServerApplicationProps is an interface
import { ServerApplicationProps } from '@aws-cdk/aws-codedeploy';

Construction properties for {@link ServerApplication}.

applicationName

The physical, human-readable name of the CodeDeploy Application.

Type:string (optional)
Default:an auto-generated name will be used

ServerDeploymentConfig

class @aws-cdk/aws-codedeploy.ServerDeploymentConfig(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentConfig;
const { ServerDeploymentConfig } = require('@aws-cdk/aws-codedeploy');
import { ServerDeploymentConfig } from '@aws-cdk/aws-codedeploy';

A custom Deployment Configuration for an EC2/on-premise Deployment Group.

Extends:

@aws-cdk/cdk.Construct

Implements:

IServerDeploymentConfig

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codedeploy.IServerDeploymentConfig

Import a custom Deployment Configuration for an EC2/on-premise Deployment Group defined either outside the CDK,

or in a different CDK Stack and exported using the {@link #export} method.

Parameters:
Returns:

a Construct representing a reference to an existing custom Deployment Configuration

Return type:

IServerDeploymentConfig

deploymentConfigArn(scope) → string

Implements @aws-cdk/aws-codedeploy.IServerDeploymentConfig.deploymentConfigArn()

Parameters:scope (@aws-cdk/cdk.IConstruct) –
Return type:string
export() → @aws-cdk/aws-codedeploy.ServerDeploymentConfigImportProps

Implements @aws-cdk/aws-codedeploy.IServerDeploymentConfig.export()

Return type:ServerDeploymentConfigImportProps
AllAtOnce
Type:IServerDeploymentConfig (readonly) (static)
HalfAtATime
Type:IServerDeploymentConfig (readonly) (static)
OneAtATime
Type:IServerDeploymentConfig (readonly) (static)
deploymentConfigName

Implements @aws-cdk/aws-codedeploy.IServerDeploymentConfig.deploymentConfigName()

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ServerDeploymentConfigImportProps (interface)

class @aws-cdk/aws-codedeploy.ServerDeploymentConfigImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentConfigImportProps;
// ServerDeploymentConfigImportProps is an interface
import { ServerDeploymentConfigImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy EC2/on-premise Deployment Configuration.

deploymentConfigName

The physical, human-readable name of the custom CodeDeploy EC2/on-premise Deployment Configuration

that we are referencing.

Type:string

ServerDeploymentConfigProps (interface)

class @aws-cdk/aws-codedeploy.ServerDeploymentConfigProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentConfigProps;
// ServerDeploymentConfigProps is an interface
import { ServerDeploymentConfigProps } from '@aws-cdk/aws-codedeploy';

Construction properties of {@link ServerDeploymentConfig}.

deploymentConfigName

The physical, human-readable name of the Deployment Configuration.

Type:string (optional)
Default:a name will be auto-generated
minHealthyHostCount

The minimum healhty hosts threshold expressed as an absolute number.

If you’ve specified this value,

you can’t specify {@link #minHealthyHostPercentage},

however one of this or {@link #minHealthyHostPercentage} is required.

Type:number (optional)
minHealthyHostPercentage

The minmum healhty hosts threshold expressed as a percentage of the fleet.

If you’ve specified this value,

you can’t specify {@link #minHealthyHostCount},

however one of this or {@link #minHealthyHostCount} is required.

Type:number (optional)

ServerDeploymentGroup

class @aws-cdk/aws-codedeploy.ServerDeploymentGroup(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentGroup;
const { ServerDeploymentGroup } = require('@aws-cdk/aws-codedeploy');
import { ServerDeploymentGroup } from '@aws-cdk/aws-codedeploy';

A CodeDeploy Deployment Group that deploys to EC2/on-premise instances.

Extends:

ServerDeploymentGroupBase

Parameters:
static import(scope, id, props) → @aws-cdk/aws-codedeploy.IServerDeploymentGroup

Import an EC2/on-premise Deployment Group defined either outside the CDK,

or in a different CDK Stack and exported using the {@link #export} method.

Parameters:
Returns:

a Construct representing a reference to an existing Deployment Group

Return type:

IServerDeploymentGroup

addAlarm(alarm)

Associates an additional alarm with this Deployment Group.

Parameters:alarm (@aws-cdk/aws-cloudwatch.Alarm) – the alarm to associate with this Deployment Group
addAutoScalingGroup(asg)

Adds an additional auto-scaling group to this Deployment Group.

Parameters:asg (@aws-cdk/aws-autoscaling.AutoScalingGroup) – the auto-scaling group to add to this Deployment Group
export() → @aws-cdk/aws-codedeploy.ServerDeploymentGroupImportProps

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.export()

Return type:ServerDeploymentGroupImportProps
application

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.application()

Type:IServerApplication (readonly)
deploymentGroupArn

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.deploymentGroupArn()

Type:string (readonly)
deploymentGroupName

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.deploymentGroupName()

Type:string (readonly)
autoScalingGroups

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.autoScalingGroups()

Type:@aws-cdk/aws-autoscaling.AutoScalingGroup[] (optional) (readonly)
role

Implements @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase.role()

Type:@aws-cdk/aws-iam.Role (optional) (readonly)
toCodePipelineDeployAction(props) → @aws-cdk/aws-codedeploy.PipelineDeployAction

Inherited from @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase

Convenience method for creating a new {@link PipelineDeployAction}.

Parameters:props (CommonPipelineDeployActionProps) –
Return type:PipelineDeployAction
deploymentConfig

Inherited from @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase

Type:IServerDeploymentConfig (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ServerDeploymentGroupBase

class @aws-cdk/aws-codedeploy.ServerDeploymentGroupBase(scope, id[, deploymentConfig])

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentGroupBase;
const { ServerDeploymentGroupBase } = require('@aws-cdk/aws-codedeploy');
import { ServerDeploymentGroupBase } from '@aws-cdk/aws-codedeploy';

Represents a reference to a CodeDeploy EC2/on-premise Deployment Group.

If you’re managing the Deployment Group alongside the rest of your CDK resources,

use the {@link ServerDeploymentGroup} class.

If you want to reference an already existing Deployment Group,

or one defined in a different CDK Stack,

use the {@link #import} method.

Extends:

@aws-cdk/cdk.Construct

Implements:

IServerDeploymentGroup

Abstract:

Yes

Parameters:
export() → @aws-cdk/aws-codedeploy.ServerDeploymentGroupImportProps

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.export()

Return type:ServerDeploymentGroupImportProps
Abstract:Yes
toCodePipelineDeployAction(props) → @aws-cdk/aws-codedeploy.PipelineDeployAction

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.toCodePipelineDeployAction()

Convenience method for creating a new {@link PipelineDeployAction}.

Parameters:props (CommonPipelineDeployActionProps) –
Return type:PipelineDeployAction
application

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.application()

Type:IServerApplication (readonly) (abstract)
deploymentConfig

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.deploymentConfig()

Type:IServerDeploymentConfig (readonly)
deploymentGroupArn

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.deploymentGroupArn()

Type:string (readonly) (abstract)
deploymentGroupName

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.deploymentGroupName()

Type:string (readonly) (abstract)
autoScalingGroups

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.autoScalingGroups()

Type:@aws-cdk/aws-autoscaling.AutoScalingGroup[] (optional) (readonly) (abstract)
role

Implements @aws-cdk/aws-codedeploy.IServerDeploymentGroup.role()

Type:@aws-cdk/aws-iam.Role (optional) (readonly) (abstract)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ServerDeploymentGroupImportProps (interface)

class @aws-cdk/aws-codedeploy.ServerDeploymentGroupImportProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentGroupImportProps;
// ServerDeploymentGroupImportProps is an interface
import { ServerDeploymentGroupImportProps } from '@aws-cdk/aws-codedeploy';

Properties of a reference to a CodeDeploy EC2/on-premise Deployment Group.

application

The reference to the CodeDeploy EC2/on-premise Application

that this Deployment Group belongs to.

Type:IServerApplication
deploymentGroupName

The physical, human-readable name of the CodeDeploy EC2/on-premise Deployment Group

that we are referencing.

Type:string
deploymentConfig

The Deployment Configuration this Deployment Group uses.

Type:IServerDeploymentConfig (optional)
Default:ServerDeploymentConfig#OneAtATime

ServerDeploymentGroupProps (interface)

class @aws-cdk/aws-codedeploy.ServerDeploymentGroupProps

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy;
import software.amazon.awscdk.services.codedeploy.ServerDeploymentGroupProps;
// ServerDeploymentGroupProps is an interface
import { ServerDeploymentGroupProps } from '@aws-cdk/aws-codedeploy';

Construction properties for {@link ServerDeploymentGroup}.

alarms

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.

Type:@aws-cdk/aws-cloudwatch.Alarm[] (optional)
Default:[]
application

The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.

If you don’t provide one, a new Application will be created.

Type:IServerApplication (optional)
autoRollback

The auto-rollback configuration for this Deployment Group.

Type:AutoRollbackConfig (optional)
autoScalingGroups

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.

Type:@aws-cdk/aws-autoscaling.AutoScalingGroup[] (optional)
Default:[]
deploymentConfig

The EC2/on-premise Deployment Configuration to use for this Deployment Group.

Type:IServerDeploymentConfig (optional)
Default:ServerDeploymentConfig#OneAtATime
deploymentGroupName

The physical, human-readable name of the CodeDeploy Deployment Group.

Type:string (optional)
Default:an auto-generated name will be used
ec2InstanceTags

All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.

Type:InstanceTagSet (optional)
Default:no additional EC2 instances will be added to the Deployment Group
ignorePollAlarmsFailure

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Type:boolean (optional)
Default:false
installAgent

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.

Type:boolean (optional)
Default:true
loadBalancer

The load balancer to place in front of this Deployment Group.

Can be either a classic Elastic Load Balancer,

or an Application Load Balancer / Network Load Balancer Target Group.

Type:@aws-cdk/aws-codedeploy-api.ILoadBalancer (optional)
Default:the Deployment Group will not have a load balancer defined
onPremiseInstanceTags

All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.

Type:InstanceTagSet (optional)
Default:no additional on-premise instances will be added to the Deployment Group
role

The service Role of this Deployment Group.

If you don’t provide one, a new Role will be created.

Type:@aws-cdk/aws-iam.Role (optional)