Class AwsCloudFormationStackProperties

Artifact properties for CloudFormation stacks.

Inheritance

System.Object

AwsCloudFormationStackProperties

Implements

IAwsCloudFormationStackProperties

Namespace: Amazon.CDK.CXAPI

Assembly: Amazon.CDK.CXAPI.dll

Syntax (csharp)

public class AwsCloudFormationStackProperties : Object, IAwsCloudFormationStackProperties

Syntax (vb)

Public Class AwsCloudFormationStackProperties
    Inherits Object
    Implements IAwsCloudFormationStackProperties

Remarks

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.CXAPI;

var awsCloudFormationStackProperties = new AwsCloudFormationStackProperties {
    TemplateFile = "templateFile",

    // the properties below are optional
    Parameters = new Dictionary<string, string> {
        { "parametersKey", "parameters" }
    },
    StackName = "stackName",
    TerminationProtection = false
};

Synopsis

Constructors

AwsCloudFormationStackProperties()

Properties

Parameters	Values for CloudFormation stack parameters that should be passed when the stack is deployed.
StackName	The name to use for the CloudFormation stack.
TemplateFile	A file relative to the assembly root which contains the CloudFormation template for this stack.
TerminationProtection	Whether to enable termination protection for this stack.

Constructors

AwsCloudFormationStackProperties()

public AwsCloudFormationStackProperties()

Properties

Parameters

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

public IDictionary<string, string> Parameters { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

StackName

The name to use for the CloudFormation stack.

public string StackName { get; set; }

Property Value

System.String

Remarks

Default: - name derived from artifact ID

TemplateFile

A file relative to the assembly root which contains the CloudFormation template for this stack.

public string TemplateFile { get; set; }

Property Value

System.String

TerminationProtection

Whether to enable termination protection for this stack.

public Nullable<bool> TerminationProtection { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Implements

IAwsCloudFormationStackProperties