Home Original page

Class StackDeployment

Deployment of a single Stack.

Inheritance

StackDeployment

Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StackDeployment : DeputyBase
Syntax (vb)
Public Class StackDeployment Inherits DeputyBase
Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CXAPI;
             using Amazon.CDK.Pipelines;

             CloudFormationStackArtifact cloudFormationStackArtifact;

             var stackDeployment = StackDeployment.FromArtifact(cloudFormationStackArtifact);

Synopsis

Properties

AbsoluteTemplatePath

Template path on disk to CloudAssembly.
Account

Account where the stack should be deployed.
Assets

Assets referenced by this stack.
AssumeRoleArn

Role to assume before deploying this stack.
ChangeSet

Steps that take place after stack is prepared but before stack deploys.
ConstructPath

Construct path for this stack.
ExecutionRoleArn

Execution role to pass to CloudFormation.
Post

Steps to execute after stack deploys.
Pre

Steps that take place before stack is prepared.
Region

Region where the stack should be deployed.
StackArtifactId

Artifact ID for this stack.
StackDependencies

Other stacks this stack depends on.
StackName

Name for this stack.
Tags

Tags to apply to the stack.
TemplateAsset

The asset that represents the CloudFormation template for this stack.
TemplateUrl

The S3 URL which points to the template asset location in the publishing bucket.

Methods

Properties

AbsoluteTemplatePath

Template path on disk to CloudAssembly.

public virtual string AbsoluteTemplatePath { get; }
Property Value

string

Account

Account where the stack should be deployed.

public virtual string? Account { get; }
Property Value

string

Assets

Assets referenced by this stack.

public virtual IStackAsset[] Assets { get; }
Property Value

IStackAsset[]

AssumeRoleArn

Role to assume before deploying this stack.

public virtual string? AssumeRoleArn { get; }
Property Value

string

ChangeSet

Steps that take place after stack is prepared but before stack deploys.

public virtual Step[] ChangeSet { get; }
Property Value

Step[]

ConstructPath

Construct path for this stack.

public virtual string ConstructPath { get; }
Property Value

string

ExecutionRoleArn

Execution role to pass to CloudFormation.

public virtual string? ExecutionRoleArn { get; }
Property Value

string

Post

Steps to execute after stack deploys.

public virtual Step[] Post { get; }
Property Value

Step[]

Pre

Steps that take place before stack is prepared.

public virtual Step[] Pre { get; }
Property Value

Step[]

Region

Region where the stack should be deployed.

public virtual string? Region { get; }
Property Value

string

StackArtifactId

Artifact ID for this stack.

public virtual string StackArtifactId { get; }
Property Value

string

StackDependencies

Other stacks this stack depends on.

public virtual StackDeployment[] StackDependencies { get; }
Property Value

StackDeployment[]

StackName

Name for this stack.

public virtual string StackName { get; }
Property Value

string

Tags

Tags to apply to the stack.

public virtual IDictionary<string, string> Tags { get; }
Property Value

IDictionary<string, string>

TemplateAsset

The asset that represents the CloudFormation template for this stack.

public virtual IStackAsset? TemplateAsset { get; }
Property Value

IStackAsset

TemplateUrl

The S3 URL which points to the template asset location in the publishing bucket.

public virtual string? TemplateUrl { get; }
Property Value

string

Methods

AddStackDependency(StackDeployment)

Add a dependency on another stack.

public virtual void AddStackDependency(StackDeployment stackDeployment)
Parameters
stackDeployment StackDeployment

AddStackSteps(Step[], Step[], Step[])

Adds steps to each phase of the stack.

public virtual void AddStackSteps(Step[] pre, Step[] changeSet, Step[] post)
Parameters
pre Step[]

steps executed before stack.prepare.

changeSet Step[]

steps executed after stack.prepare and before stack.deploy.

post Step[]

steps executed after stack.deploy.

FromArtifact(CloudFormationStackArtifact)

Build a StackDeployment from a Stack Artifact in a Cloud Assembly.

public static StackDeployment FromArtifact(CloudFormationStackArtifact stackArtifact)
Parameters
stackArtifact CloudFormationStackArtifact
Returns

StackDeployment