interface CfnChangeSetProps

Language	Type name
.NET	Amazon.CDK.CfnChangeSetProps
Go	github.com/aws/aws-cdk-go/awscdk/v2#CfnChangeSetProps
Java	software.amazon.awscdk.CfnChangeSetProps
Python	aws_cdk.CfnChangeSetProps
TypeScript	aws-cdk-lib » CfnChangeSetProps

Properties for defining a CfnChangeSet.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnChangeSetProps: cdk.CfnChangeSetProps = {
  changeSetName: 'changeSetName',
  stackName: 'stackName',

  // the properties below are optional
  capabilities: ['capabilities'],
  changeSetType: 'changeSetType',
  deploymentMode: 'deploymentMode',
  description: 'description',
  importExistingResources: false,
  includeNestedStacks: false,
  notificationArns: ['notificationArns'],
  onStackFailure: 'onStackFailure',
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateBody: 'templateBody',
  templateUrl: 'templateUrl',
  usePreviousTemplate: false,
};

Properties

Name	Type	Description
changeSetName	string	The name of the change set.
stackName	string	The name or unique ID of the stack for which you are creating a change set.
capabilities?	string[]	The capabilities that are allowed in the stack.
changeSetType?	string	The type of change set operation.
deploymentMode?	string	Determines how CloudFormation handles configuration drift during deployment.
description?	string	A description to help you identify this change set.
importExistingResources?	boolean | IResolvable	Indicates if the change set imports resources that already exist.
includeNestedStacks?	boolean | IResolvable	Creates a change set for all nested stacks specified in the template.
notificationArns?	string[]	The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
onStackFailure?	string	Determines what action will be taken if stack creation fails.
roleArn?	string	The ARN of an IAM role that CloudFormation assumes when executing the change set.
tags?	TagsItemsProperty[]	Key-value pairs to associate with the change set.
templateBody?	string	A structure that contains the body of the revised template.
templateUrl?	string	The URL of the file that contains the revised template.
usePreviousTemplate?	boolean | IResolvable	Whether to reuse the template associated with the stack to create the change set.

---

changeSetName

Type: string

The name of the change set.

Must be unique among all change sets associated with the specified stack.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesetname

---

stackName

Type: string

The name or unique ID of the stack for which you are creating a change set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-stackname

---

capabilities?

Type: string[] (optional)

The capabilities that are allowed in the stack.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-capabilities

---

changeSetType?

Type: string (optional)

The type of change set operation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesettype

---

deploymentMode?

Type: string (optional)

Determines how CloudFormation handles configuration drift during deployment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-deploymentmode

---

description?

Type: string (optional)

A description to help you identify this change set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-description

---

importExistingResources?

Type: boolean | IResolvable (optional)

Indicates if the change set imports resources that already exist.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-importexistingresources

---

includeNestedStacks?

Type: boolean | IResolvable (optional)

Creates a change set for all nested stacks specified in the template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-includenestedstacks

---

notificationArns?

Type: string[] (optional)

The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-notificationarns

---

onStackFailure?

Type: string (optional)

Determines what action will be taken if stack creation fails.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-onstackfailure

---

roleArn?

Type: string (optional)

The ARN of an IAM role that CloudFormation assumes when executing the change set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-rolearn

---

tags?

Type: TagsItemsProperty[] (optional)

Key-value pairs to associate with the change set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-tags

---

templateBody?

Type: string (optional)

A structure that contains the body of the revised template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templatebody

---

templateUrl?

Type: string (optional)

The URL of the file that contains the revised template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templateurl

---

usePreviousTemplate?

Type: boolean | IResolvable (optional)

Whether to reuse the template associated with the stack to create the change set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-useprevioustemplate