class CfnDeploymentGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodeDeploy.Mixins.CfnDeploymentGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodedeploy/mixins#CfnDeploymentGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.codedeploy.mixins.CfnDeploymentGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_codedeploy.mixins.CfnDeploymentGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_codedeploy » mixins » CfnDeploymentGroupPropsMixin

Implements IMixin

Extends Mixin

The AWS::CodeDeploy::DeploymentGroup resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.

For more information, see CreateDeploymentGroup in the CodeDeploy API Reference .

Amazon ECS blue/green deployments through CodeDeploy do not use the AWS::CodeDeploy::DeploymentGroup resource. To perform Amazon ECS blue/green deployments, use the AWS::CodeDeploy::BlueGreen hook. See Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation for more information.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as codedeploy_mixins } from '@aws-cdk/mixins-preview/aws-codedeploy';
const cfnDeploymentGroupPropsMixin = new codedeploy_mixins.CfnDeploymentGroupPropsMixin({
  alarmConfiguration: {
    alarms: [{
      name: 'name',
    }],
    enabled: false,
    ignorePollAlarmFailure: false,
  },
  applicationName: 'applicationName',
  autoRollbackConfiguration: {
    enabled: false,
    events: ['events'],
  },
  autoScalingGroups: ['autoScalingGroups'],
  blueGreenDeploymentConfiguration: {
    deploymentReadyOption: {
      actionOnTimeout: 'actionOnTimeout',
      waitTimeInMinutes: 123,
    },
    greenFleetProvisioningOption: {
      action: 'action',
    },
    terminateBlueInstancesOnDeploymentSuccess: {
      action: 'action',
      terminationWaitTimeInMinutes: 123,
    },
  },
  deployment: {
    description: 'description',
    ignoreApplicationStopFailures: false,
    revision: {
      gitHubLocation: {
        commitId: 'commitId',
        repository: 'repository',
      },
      revisionType: 'revisionType',
      s3Location: {
        bucket: 'bucket',
        bundleType: 'bundleType',
        eTag: 'eTag',
        key: 'key',
        version: 'version',
      },
    },
  },
  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',
  serviceRoleArn: 'serviceRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  terminationHookEnabled: false,
  triggerConfigurations: [{
    triggerEvents: ['triggerEvents'],
    triggerName: 'triggerName',
    triggerTargetArn: 'triggerTargetArn',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDeploymentGroupPropsMixin(props: CfnDeploymentGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDeploymentGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CodeDeploy::DeploymentGroup.

Properties

Name	Type	Description
props	CfnDeploymentGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDeploymentGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.