Class AwsCloudFormationStackProperties
Artifact properties for CloudFormation stacks.
Inheritance
Implements
Namespace: Amazon.CDK.CloudAssembly.Schema
Assembly: Amazon.CDK.CloudAssembly.Schema.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.CloudAssembly.Schema;
var awsCloudFormationStackProperties = new AwsCloudFormationStackProperties {
TemplateFile = "templateFile",
// the properties below are optional
AssumeRoleArn = "assumeRoleArn",
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
LookupRole = new BootstrapRole {
Arn = "arn",
// the properties below are optional
AssumeRoleExternalId = "assumeRoleExternalId",
BootstrapStackVersionSsmParameter = "bootstrapStackVersionSsmParameter",
RequiresBootstrapStackVersion = 123
},
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RequiresBootstrapStackVersion = 123,
StackName = "stackName",
StackTemplateAssetObjectUrl = "stackTemplateAssetObjectUrl",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TerminationProtection = false,
ValidateOnSynth = false
};
Synopsis
Constructors
AwsCloudFormationStackProperties() |
Properties
AssumeRoleArn | The role that needs to be assumed to deploy the stack. |
AssumeRoleExternalId | External ID to use when assuming role for cloudformation deployments. |
BootstrapStackVersionSsmParameter | SSM parameter where the bootstrap stack version number can be found. |
CloudFormationExecutionRoleArn | The role that is passed to CloudFormation to execute the change set. |
LookupRole | The role to use to look up values from the target AWS account. |
Parameters | Values for CloudFormation stack parameters that should be passed when the stack is deployed. |
RequiresBootstrapStackVersion | Version of bootstrap stack required to deploy this stack. |
StackName | The name to use for the CloudFormation stack. |
StackTemplateAssetObjectUrl | If the stack template has already been included in the asset manifest, its asset URL. |
Tags | Values for CloudFormation stack tags that should be passed when the stack is deployed. |
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. |
ValidateOnSynth | Whether this stack should be validated by the CLI after synthesis. |
Constructors
AwsCloudFormationStackProperties()
public AwsCloudFormationStackProperties()
Properties
AssumeRoleArn
The role that needs to be assumed to deploy the stack.
public string AssumeRoleArn { get; set; }
Property Value
System.String
Remarks
Default: - No role is assumed (current credentials are used)
AssumeRoleExternalId
External ID to use when assuming role for cloudformation deployments.
public string AssumeRoleExternalId { get; set; }
Property Value
System.String
Remarks
Default: - No external ID
BootstrapStackVersionSsmParameter
SSM parameter where the bootstrap stack version number can be found.
public string BootstrapStackVersionSsmParameter { get; set; }
Property Value
System.String
Remarks
Only used if requiresBootstrapStackVersion
is set.
Default: - Bootstrap stack version number looked up
CloudFormationExecutionRoleArn
The role that is passed to CloudFormation to execute the change set.
public string CloudFormationExecutionRoleArn { get; set; }
Property Value
System.String
Remarks
Default: - No role is passed (currently assumed role/credentials are used)
LookupRole
The role to use to look up values from the target AWS account.
public IBootstrapRole LookupRole { get; set; }
Property Value
Remarks
Default: - No role is assumed (current credentials are used)
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>
Remarks
Default: - No parameters
RequiresBootstrapStackVersion
Version of bootstrap stack required to deploy this stack.
public Nullable<double> RequiresBootstrapStackVersion { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - No bootstrap stack required
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
StackTemplateAssetObjectUrl
If the stack template has already been included in the asset manifest, its asset URL.
public string StackTemplateAssetObjectUrl { get; set; }
Property Value
System.String
Remarks
Default: - Not uploaded yet, upload just before deploying
Tags
Values for CloudFormation stack tags that should be passed when the stack is deployed.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No tags
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
ValidateOnSynth
Whether this stack should be validated by the CLI after synthesis.
public Nullable<bool> ValidateOnSynth { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false