Class StackDeployment
Deployment of a single Stack.
Inheritance
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StackDeployment : DeputyBase
Syntax (vb)
Public Class StackDeployment
Inherits DeputyBase
Remarks
You don't need to instantiate this class -- it will
be automatically instantiated as necessary when you
add a Stage
to a pipeline.
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;
using Amazon.CDK.Pipelines;
CloudFormationStackArtifact cloudFormationStackArtifact;
var stackDeployment = StackDeployment.FromArtifact(cloudFormationStackArtifact);
Synopsis
Constructors
StackDeployment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
StackDeployment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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
AddStackDependency(StackDeployment) | Add a dependency on another stack. |
AddStackSteps(Step[], Step[], Step[]) | Adds steps to each phase of the stack. |
FromArtifact(CloudFormationStackArtifact) | Build a |
Constructors
StackDeployment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected StackDeployment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
StackDeployment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected StackDeployment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AbsoluteTemplatePath
Template path on disk to CloudAssembly.
public virtual string AbsoluteTemplatePath { get; }
Property Value
System.String
Account
Account where the stack should be deployed.
public virtual string Account { get; }
Property Value
System.String
Remarks
Default: - Pipeline account
Assets
Assets referenced by this stack.
public virtual IStackAsset[] Assets { get; }
Property Value
AssumeRoleArn
Role to assume before deploying this stack.
public virtual string AssumeRoleArn { get; }
Property Value
System.String
Remarks
Default: - Don't assume any role
ChangeSet
Steps that take place after stack is prepared but before stack deploys.
public virtual Step[] ChangeSet { get; }
Property Value
Step[]
Remarks
Your pipeline engine may not disable prepareStep
.
ConstructPath
Construct path for this stack.
public virtual string ConstructPath { get; }
Property Value
System.String
ExecutionRoleArn
Execution role to pass to CloudFormation.
public virtual string ExecutionRoleArn { get; }
Property Value
System.String
Remarks
Default: - No execution role
Post
Pre
Steps that take place before stack is prepared.
public virtual Step[] Pre { get; }
Property Value
Step[]
Remarks
If your pipeline engine disables 'prepareStep', then this will happen before stack deploys
Region
Region where the stack should be deployed.
public virtual string Region { get; }
Property Value
System.String
Remarks
Default: - Pipeline region
StackArtifactId
Artifact ID for this stack.
public virtual string StackArtifactId { get; }
Property Value
System.String
StackDependencies
Other stacks this stack depends on.
public virtual StackDeployment[] StackDependencies { get; }
Property Value
StackName
Name for this stack.
public virtual string StackName { get; }
Property Value
System.String
Tags
Tags to apply to the stack.
public virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
TemplateAsset
The asset that represents the CloudFormation template for this stack.
public virtual IStackAsset TemplateAsset { get; }
Property Value
TemplateUrl
The S3 URL which points to the template asset location in the publishing bucket.
public virtual string TemplateUrl { get; }
Property Value
System.String
Remarks
This is undefined
if the stack template is not published. Use the
DefaultStackSynthesizer
to ensure it is.
Example value: https://bucket.s3.amazonaws.com/object/key
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
FromArtifact(CloudFormationStackArtifact)
Build a StackDeployment
from a Stack Artifact in a Cloud Assembly.
public static StackDeployment FromArtifact(CloudFormationStackArtifact stackArtifact)
Parameters
- stackArtifact CloudFormationStackArtifact
Returns