Class CloudFormationStackArtifact
Inherited Members
Namespace: Amazon.CDK.CXAPI
Assembly: Amazon.CDK.CXAPI.dll
Syntax (csharp)
public class CloudFormationStackArtifact : CloudArtifact
Syntax (vb)
Public Class CloudFormationStackArtifact
Inherits CloudArtifact
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;
using Amazon.CDK.CXAPI;
CloudAssembly cloudAssembly;
var cloudFormationStackArtifact = new CloudFormationStackArtifact(cloudAssembly, "artifactId", new ArtifactManifest {
Type = ArtifactType.NONE,
// the properties below are optional
Dependencies = new [] { "dependencies" },
DisplayName = "displayName",
Environment = "environment",
Metadata = new Dictionary<string, MetadataEntry[]> {
{ "metadataKey", new [] { new MetadataEntry {
Type = "type",
// the properties below are optional
Data = "data",
Trace = new [] { "trace" }
} } }
},
Properties = 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
CloudFormationStackArtifact(CloudAssembly, String, IArtifactManifest) | |
CloudFormationStackArtifact(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CloudFormationStackArtifact(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Assets | Any assets associated with this stack. |
AssumeRoleArn | The role that needs to be assumed to deploy the stack. |
AssumeRoleExternalId | External ID to use when assuming role for cloudformation deployments. |
BootstrapStackVersionSsmParameter | Name of SSM parameter with bootstrap stack version. |
CloudFormationExecutionRoleArn | The role that is passed to CloudFormation to execute the change set. |
DisplayName | A string that represents this stack. |
Environment | The environment into which to deploy this artifact. |
LookupRole | The role to use to look up values from the target AWS account. |
Name | (deprecated) The physical name of this stack. |
OriginalName | The original name as defined in the CDK app. |
Parameters | CloudFormation parameters to pass to the stack. |
RequiresBootstrapStackVersion | Version of bootstrap stack required to deploy this stack. |
StackName | The physical name of this stack. |
StackTemplateAssetObjectUrl | If the stack template has already been included in the asset manifest, its asset URL. |
Tags | CloudFormation tags to pass to the stack. |
Template | The CloudFormation template for this stack. |
TemplateFile | The file name of the template. |
TemplateFullPath | Full path to the template file. |
TerminationProtection | Whether termination protection is enabled for this stack. |
ValidateOnSynth | Whether this stack should be validated by the CLI after synthesis. |
Constructors
CloudFormationStackArtifact(CloudAssembly, String, IArtifactManifest)
public CloudFormationStackArtifact(CloudAssembly assembly, string artifactId, IArtifactManifest artifact)
Parameters
- assembly CloudAssembly
- artifactId System.String
- artifact IArtifactManifest
CloudFormationStackArtifact(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CloudFormationStackArtifact(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CloudFormationStackArtifact(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CloudFormationStackArtifact(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Assets
Any assets associated with this stack.
public virtual object[] Assets { get; }
Property Value
System.Object[]
AssumeRoleArn
The role that needs to be assumed to deploy the stack.
public virtual string AssumeRoleArn { get; }
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 virtual string AssumeRoleExternalId { get; }
Property Value
System.String
Remarks
Default: - No external ID
BootstrapStackVersionSsmParameter
Name of SSM parameter with bootstrap stack version.
public virtual string BootstrapStackVersionSsmParameter { get; }
Property Value
System.String
Remarks
Default: - Discover SSM parameter by reading stack
CloudFormationExecutionRoleArn
The role that is passed to CloudFormation to execute the change set.
public virtual string CloudFormationExecutionRoleArn { get; }
Property Value
System.String
Remarks
Default: - No role is passed (currently assumed role/credentials are used)
DisplayName
A string that represents this stack.
public virtual string DisplayName { get; }
Property Value
System.String
Remarks
Should only be used in user
interfaces. If the stackName has not been set explicitly, or has been set
to artifactId, it will return the hierarchicalId of the stack. Otherwise,
it will return something like "
Environment
The environment into which to deploy this artifact.
public virtual IEnvironment Environment { get; }
Property Value
LookupRole
The role to use to look up values from the target AWS account.
public virtual IBootstrapRole LookupRole { get; }
Property Value
Remarks
Default: - No role is assumed (current credentials are used)
Name
(deprecated) The physical name of this stack.
public virtual string Name { get; }
Property Value
System.String
Remarks
Stability: Deprecated
OriginalName
The original name as defined in the CDK app.
public virtual string OriginalName { get; }
Property Value
System.String
Parameters
CloudFormation parameters to pass to the stack.
public virtual IDictionary<string, string> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
RequiresBootstrapStackVersion
Version of bootstrap stack required to deploy this stack.
public virtual Nullable<double> RequiresBootstrapStackVersion { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - No bootstrap stack required
StackName
The physical name of this stack.
public virtual string StackName { get; }
Property Value
System.String
StackTemplateAssetObjectUrl
If the stack template has already been included in the asset manifest, its asset URL.
public virtual string StackTemplateAssetObjectUrl { get; }
Property Value
System.String
Remarks
Default: - Not uploaded yet, upload just before deploying
Tags
CloudFormation tags to pass to the stack.
public virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Template
The CloudFormation template for this stack.
public virtual object Template { get; }
Property Value
System.Object
TemplateFile
The file name of the template.
public virtual string TemplateFile { get; }
Property Value
System.String
TemplateFullPath
Full path to the template file.
public virtual string TemplateFullPath { get; }
Property Value
System.String
TerminationProtection
Whether termination protection is enabled for this stack.
public virtual Nullable<bool> TerminationProtection { get; }
Property Value
System.Nullable<System.Boolean>
ValidateOnSynth
Whether this stack should be validated by the CLI after synthesis.
public virtual Nullable<bool> ValidateOnSynth { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false