Class CfnChangeSetProps

Properties for defining a CfnChangeSet.

Inheritance

object

CfnChangeSetProps

Implements

ICfnChangeSetProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CloudFormation

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnChangeSetProps : ICfnChangeSetProps

Syntax (vb)

Public Class CfnChangeSetProps Implements ICfnChangeSetProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudFormation;

             var cfnChangeSetProps = new CfnChangeSetProps {
                 ChangeSetName = "changeSetName",
                 StackName = "stackName",

                 // the properties below are optional
                 Capabilities = new [] { "capabilities" },
                 ChangeSetType = "changeSetType",
                 DeploymentMode = "deploymentMode",
                 Description = "description",
                 ImportExistingResources = false,
                 IncludeNestedStacks = false,
                 NotificationArns = new [] { "notificationArns" },
                 OnStackFailure = "onStackFailure",
                 RoleArn = "roleArn",
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateBody = "templateBody",
                 TemplateUrl = "templateUrl",
                 UsePreviousTemplate = false
             };

Synopsis

Constructors

CfnChangeSetProps()

Properties for defining a CfnChangeSet.

Properties

Capabilities	The capabilities that are allowed in the stack.
ChangeSetName	The name of the change set.
ChangeSetType	The type of change set operation.
DeploymentMode	Determines how CloudFormation handles configuration drift during deployment.
Description	A description to help you identify this change set.
ImportExistingResources	Indicates if the change set imports resources that already exist.
IncludeNestedStacks	Creates a change set for all nested stacks specified in the template.
NotificationArns	The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
OnStackFailure	Determines what action will be taken if stack creation fails.
RoleArn	The ARN of an IAM role that CloudFormation assumes when executing the change set.
StackName	The name or unique ID of the stack for which you are creating a change set.
Tags	Key-value pairs to associate with the change set.
TemplateBody	A structure that contains the body of the revised template.
TemplateUrl	The URL of the file that contains the revised template.
UsePreviousTemplate	Whether to reuse the template associated with the stack to create the change set.

Constructors

CfnChangeSetProps()

Properties for defining a CfnChangeSet.

public CfnChangeSetProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudFormation;

             var cfnChangeSetProps = new CfnChangeSetProps {
                 ChangeSetName = "changeSetName",
                 StackName = "stackName",

                 // the properties below are optional
                 Capabilities = new [] { "capabilities" },
                 ChangeSetType = "changeSetType",
                 DeploymentMode = "deploymentMode",
                 Description = "description",
                 ImportExistingResources = false,
                 IncludeNestedStacks = false,
                 NotificationArns = new [] { "notificationArns" },
                 OnStackFailure = "onStackFailure",
                 RoleArn = "roleArn",
                 Tags = new [] { new TagsItemsProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateBody = "templateBody",
                 TemplateUrl = "templateUrl",
                 UsePreviousTemplate = false
             };

Properties

Capabilities

The capabilities that are allowed in the stack.

public string[]? Capabilities { get; set; }

Property Value

string[]

Remarks

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

ChangeSetName

The name of the change set.

public string ChangeSetName { get; set; }

Property Value

string

Remarks

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

ChangeSetType

The type of change set operation.

public string? ChangeSetType { get; set; }

Property Value

string

Remarks

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

DeploymentMode

Determines how CloudFormation handles configuration drift during deployment.

public string? DeploymentMode { get; set; }

Property Value

string

Remarks

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.

public string? Description { get; set; }

Property Value

string

Remarks

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

ImportExistingResources

Indicates if the change set imports resources that already exist.

public object? ImportExistingResources { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

IncludeNestedStacks

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

public object? IncludeNestedStacks { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

NotificationArns

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

public string[]? NotificationArns { get; set; }

Property Value

string[]

Remarks

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

OnStackFailure

Determines what action will be taken if stack creation fails.

public string? OnStackFailure { get; set; }

Property Value

string

Remarks

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

RoleArn

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

public string? RoleArn { get; set; }

Property Value

string

Remarks

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

StackName

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

public string StackName { get; set; }

Property Value

string

Remarks

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.

public CfnChangeSet.ITagsItemsProperty[]? Tags { get; set; }

Property Value

ITagsItemsProperty[]

Remarks

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

TemplateBody

A structure that contains the body of the revised template.

public string? TemplateBody { get; set; }

Property Value

string

Remarks

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

TemplateUrl

The URL of the file that contains the revised template.

public string? TemplateUrl { get; set; }

Property Value

string

Remarks

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

UsePreviousTemplate

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

public object? UsePreviousTemplate { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

Implements

ICfnChangeSetProps