CfnChangeSetProps

class aws_cdk.CfnChangeSetProps(*, change_set_name, stack_name, capabilities=None, change_set_type=None, deployment_mode=None, description=None, import_existing_resources=None, include_nested_stacks=None, notification_arns=None, on_stack_failure=None, role_arn=None, tags=None, template_body=None, template_url=None, use_previous_template=None)

Bases: object

Properties for defining a CfnChangeSet.

Parameters:
  • change_set_name (str) – The name of the change set. Must be unique among all change sets associated with the specified stack.

  • stack_name (str) – The name or unique ID of the stack for which you are creating a change set.

  • capabilities (Optional[Sequence[str]]) – The capabilities that are allowed in the stack.

  • change_set_type (Optional[str]) – The type of change set operation.

  • deployment_mode (Optional[str]) – Determines how CloudFormation handles configuration drift during deployment.

  • description (Optional[str]) – A description to help you identify this change set.

  • import_existing_resources (Union[bool, IResolvable, None]) – Indicates if the change set imports resources that already exist.

  • include_nested_stacks (Union[bool, IResolvable, None]) – Creates a change set for all nested stacks specified in the template.

  • notification_arns (Optional[Sequence[str]]) – The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

  • on_stack_failure (Optional[str]) – Determines what action will be taken if stack creation fails.

  • role_arn (Optional[str]) – The ARN of an IAM role that CloudFormation assumes when executing the change set.

  • tags (Optional[Sequence[Union[TagsItemsProperty, Dict[str, Any]]]]) – Key-value pairs to associate with the change set.

  • template_body (Optional[str]) – A structure that contains the body of the revised template.

  • template_url (Optional[str]) – The URL of the file that contains the revised template.

  • use_previous_template (Union[bool, IResolvable, None]) – Whether to reuse the template associated with the stack to create the change set.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_change_set_props = cdk.CfnChangeSetProps(
    change_set_name="changeSetName",
    stack_name="stackName",

    # the properties below are optional
    capabilities=["capabilities"],
    change_set_type="changeSetType",
    deployment_mode="deploymentMode",
    description="description",
    import_existing_resources=False,
    include_nested_stacks=False,
    notification_arns=["notificationArns"],
    on_stack_failure="onStackFailure",
    role_arn="roleArn",
    tags=[cdk.CfnChangeSet.TagsItemsProperty(
        key="key",
        value="value"
    )],
    template_body="templateBody",
    template_url="templateUrl",
    use_previous_template=False
)

Attributes

capabilities

The capabilities that are allowed in the stack.

See:

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

change_set_name

The name of the change set.

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

See:

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

change_set_type

The type of change set operation.

See:

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

deployment_mode

Determines how CloudFormation handles configuration drift during deployment.

See:

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

description

A description to help you identify this change set.

See:

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

import_existing_resources

Indicates if the change set imports resources that already exist.

See:

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

include_nested_stacks

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

See:

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

notification_arns

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

See:

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

on_stack_failure

Determines what action will be taken if stack creation fails.

See:

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

role_arn

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

See:

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

stack_name

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

See:

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

tags

Key-value pairs to associate with the change set.

See:

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

template_body

A structure that contains the body of the revised template.

See:

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

template_url

The URL of the file that contains the revised template.

See:

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

use_previous_template

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

See:

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