1.204.0

interface CfnDeploymentGroupProps

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

Properties for defining a CfnDeploymentGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codedeploy from '@aws-cdk/aws-codedeploy';
const cfnDeploymentGroupProps: codedeploy.CfnDeploymentGroupProps = {
  applicationName: 'applicationName',
  serviceRoleArn: 'serviceRoleArn',

  // the properties below are optional
  alarmConfiguration: {
    alarms: [{
      name: 'name',
    }],
    enabled: false,
    ignorePollAlarmFailure: false,
  },
  autoRollbackConfiguration: {
    enabled: false,
    events: ['events'],
  },
  autoScalingGroups: ['autoScalingGroups'],
  blueGreenDeploymentConfiguration: {
    deploymentReadyOption: {
      actionOnTimeout: 'actionOnTimeout',
      waitTimeInMinutes: 123,
    },
    greenFleetProvisioningOption: {
      action: 'action',
    },
    terminateBlueInstancesOnDeploymentSuccess: {
      action: 'action',
      terminationWaitTimeInMinutes: 123,
    },
  },
  deployment: {
    revision: {
      gitHubLocation: {
        commitId: 'commitId',
        repository: 'repository',
      },
      revisionType: 'revisionType',
      s3Location: {
        bucket: 'bucket',
        key: 'key',

        // the properties below are optional
        bundleType: 'bundleType',
        eTag: 'eTag',
        version: 'version',
      },
    },

    // the properties below are optional
    description: 'description',
    ignoreApplicationStopFailures: false,
  },
  deploymentConfigName: 'deploymentConfigName',
  deploymentGroupName: 'deploymentGroupName',
  deploymentStyle: {
    deploymentOption: 'deploymentOption',
    deploymentType: 'deploymentType',
  },
  ec2TagFilters: [{
    key: 'key',
    type: 'type',
    value: 'value',
  }],
  ec2TagSet: {
    ec2TagSetList: [{
      ec2TagGroup: [{
        key: 'key',
        type: 'type',
        value: 'value',
      }],
    }],
  },
  ecsServices: [{
    clusterName: 'clusterName',
    serviceName: 'serviceName',
  }],
  loadBalancerInfo: {
    elbInfoList: [{
      name: 'name',
    }],
    targetGroupInfoList: [{
      name: 'name',
    }],
    targetGroupPairInfoList: [{
      prodTrafficRoute: {
        listenerArns: ['listenerArns'],
      },
      targetGroups: [{
        name: 'name',
      }],
      testTrafficRoute: {
        listenerArns: ['listenerArns'],
      },
    }],
  },
  onPremisesInstanceTagFilters: [{
    key: 'key',
    type: 'type',
    value: 'value',
  }],
  onPremisesTagSet: {
    onPremisesTagSetList: [{
      onPremisesTagGroup: [{
        key: 'key',
        type: 'type',
        value: 'value',
      }],
    }],
  },
  outdatedInstancesStrategy: 'outdatedInstancesStrategy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggerConfigurations: [{
    triggerEvents: ['triggerEvents'],
    triggerName: 'triggerName',
    triggerTargetArn: 'triggerTargetArn',
  }],
};

Properties

NameTypeDescription
applicationNamestringThe name of an existing CodeDeploy application to associate this deployment group with.
serviceRoleArnstringA service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.
alarmConfiguration?IResolvable | AlarmConfigurationPropertyInformation about the Amazon CloudWatch alarms that are associated with the deployment group.
autoRollbackConfiguration?IResolvable | AutoRollbackConfigurationPropertyInformation about the automatic rollback configuration that is associated with the deployment group.
autoScalingGroups?string[]A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.
blueGreenDeploymentConfiguration?IResolvable | BlueGreenDeploymentConfigurationPropertyInformation about blue/green deployment options for a deployment group.
deployment?IResolvable | DeploymentPropertyThe application revision to deploy to this deployment group.
deploymentConfigName?stringA deployment configuration name or a predefined configuration name.
deploymentGroupName?stringA name for the deployment group.
deploymentStyle?IResolvable | DeploymentStylePropertyAttributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.
ec2TagFilters?IResolvable | IResolvable | EC2TagFilterProperty[]The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.
ec2TagSet?IResolvable | EC2TagSetPropertyInformation about groups of tags applied to Amazon EC2 instances.
ecsServices?IResolvable | IResolvable | ECSServiceProperty[]The target Amazon ECS services in the deployment group.
loadBalancerInfo?IResolvable | LoadBalancerInfoPropertyInformation about the load balancer to use in a deployment.
onPremisesInstanceTagFilters?IResolvable | IResolvable | TagFilterProperty[]The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.
onPremisesTagSet?IResolvable | OnPremisesTagSetPropertyInformation about groups of tags applied to on-premises instances.
outdatedInstancesStrategy?stringAWS::CodeDeploy::DeploymentGroup.OutdatedInstancesStrategy.
tags?CfnTag[]AWS::CodeDeploy::DeploymentGroup.Tags.
triggerConfigurations?IResolvable | IResolvable | TriggerConfigProperty[]Information about triggers associated with the deployment group.

applicationName

Type: string

The name of an existing CodeDeploy application to associate this deployment group with.

serviceRoleArn

Type: string

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf.

For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide .

In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in DependsOn Attribute .

alarmConfiguration?

Type: IResolvable | AlarmConfigurationProperty (optional)

Information about the Amazon CloudWatch alarms that are associated with the deployment group.

autoRollbackConfiguration?

Type: IResolvable | AutoRollbackConfigurationProperty (optional)

Information about the automatic rollback configuration that is associated with the deployment group.

If you specify this property, don't specify the Deployment property.

autoScalingGroups?

Type: string[] (optional)

A list of associated Auto Scaling groups that CodeDeploy automatically deploys revisions to when new instances are created.

Duplicates are not allowed.

blueGreenDeploymentConfiguration?

Type: IResolvable | BlueGreenDeploymentConfigurationProperty (optional)

Information about blue/green deployment options for a deployment group.

deployment?

Type: IResolvable | DeploymentProperty (optional)

The application revision to deploy to this deployment group.

If you specify this property, your target application revision is deployed as soon as the provisioning process is complete. If you specify this property, don't specify the AutoRollbackConfiguration property.

deploymentConfigName?

Type: string (optional)

A deployment configuration name or a predefined configuration name.

With predefined configurations, you can deploy application revisions to one instance at a time ( CodeDeployDefault.OneAtATime ), half of the instances at a time ( CodeDeployDefault.HalfAtATime ), or all the instances at once ( CodeDeployDefault.AllAtOnce ). For more information and valid values, see Working with Deployment Configurations in the AWS CodeDeploy User Guide .

deploymentGroupName?

Type: string (optional)

A name for the deployment group.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

deploymentStyle?

Type: IResolvable | DeploymentStyleProperty (optional)

Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer.

If you specify this property with a blue/green deployment type, don't specify the AutoScalingGroups , LoadBalancerInfo , or Deployment properties.

For blue/green deployments, AWS CloudFormation supports deployments on Lambda compute platforms only. You can perform Amazon ECS blue/green deployments using AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using AWS CloudFormation for more information.

ec2TagFilters?

Type: IResolvable | IResolvable | EC2TagFilterProperty[] (optional)

The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.

CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.

You can specify EC2TagFilters or Ec2TagSet , but not both.

ec2TagSet?

Type: IResolvable | EC2TagSetProperty (optional)

Information about groups of tags applied to Amazon EC2 instances.

The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilter .

ecsServices?

Type: IResolvable | IResolvable | ECSServiceProperty[] (optional)

The target Amazon ECS services in the deployment group.

This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename> .

loadBalancerInfo?

Type: IResolvable | LoadBalancerInfoProperty (optional)

Information about the load balancer to use in a deployment.

For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide .

onPremisesInstanceTagFilters?

Type: IResolvable | IResolvable | TagFilterProperty[] (optional)

The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group.

CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with CodeDeploy , see Working with On-Premises Instances for CodeDeploy in the AWS CodeDeploy User Guide . Duplicates are not allowed.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

onPremisesTagSet?

Type: IResolvable | OnPremisesTagSetProperty (optional)

Information about groups of tags applied to on-premises instances.

The deployment group includes only on-premises instances identified by all the tag groups.

You can specify OnPremisesInstanceTagFilters or OnPremisesInstanceTagSet , but not both.

outdatedInstancesStrategy?

Type: string (optional)

AWS::CodeDeploy::DeploymentGroup.OutdatedInstancesStrategy.

tags?

Type: CfnTag[] (optional)

AWS::CodeDeploy::DeploymentGroup.Tags.

triggerConfigurations?

Type: IResolvable | IResolvable | TriggerConfigProperty[] (optional)

Information about triggers associated with the deployment group.

Duplicates are not allowed

← PreviousNext →