class CfnDeploymentPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppConfig.Mixins.CfnDeploymentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappconfig/mixins#CfnDeploymentPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.appconfig.mixins.CfnDeploymentPropsMixin
Python	aws_cdk.mixins_preview.aws_appconfig.mixins.CfnDeploymentPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_appconfig » mixins » CfnDeploymentPropsMixin

Implements IMixin

Extends Mixin

The AWS::AppConfig::Deployment resource starts a deployment.

Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AWS AppConfig application, the environment, the configuration profile, and (optionally) the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed.

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

• Create an application
• Create an environment
• Create a configuration profile
• Choose a pre-defined deployment strategy or create your own
• Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.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 appconfig_mixins } from '@aws-cdk/mixins-preview/aws-appconfig';
const cfnDeploymentPropsMixin = new appconfig_mixins.CfnDeploymentPropsMixin({
  applicationId: 'applicationId',
  configurationProfileId: 'configurationProfileId',
  configurationVersion: 'configurationVersion',
  deploymentStrategyId: 'deploymentStrategyId',
  description: 'description',
  dynamicExtensionParameters: [{
    extensionReference: 'extensionReference',
    parameterName: 'parameterName',
    parameterValue: 'parameterValue',
  }],
  environmentId: 'environmentId',
  kmsKeyIdentifier: 'kmsKeyIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDeploymentPropsMixin(props: CfnDeploymentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::AppConfig::Deployment.

Properties

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

---

props

Type: CfnDeploymentMixinProps

---

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.