software.amazon.awscdk.pipelines

Class StackDeployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.StackDeployment

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.945Z")
 @Stability(value=Stable)
public class StackDeployment
extends software.amazon.jsii.JsiiObject

Deployment of a single Stack.

You don't need to instantiate this class -- it will be automatically instantiated as necessary when you add a Stage to a pipeline.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cxapi.*;
 import software.amazon.awscdk.pipelines.*;
 CloudFormationStackArtifact cloudFormationStackArtifact;
 StackDeployment stackDeployment = StackDeployment.fromArtifact(cloudFormationStackArtifact);
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StackDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StackDeployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addStackDependency(StackDeployment stackDeployment) Add a dependency on another stack.
void	addStackSteps(List<Step> pre, List<Step> changeSet, List<Step> post) Adds steps to each phase of the stack.
static StackDeployment	fromArtifact(CloudFormationStackArtifact stackArtifact) Build a `StackDeployment` from a Stack Artifact in a Cloud Assembly.
String	getAbsoluteTemplatePath() Template path on disk to CloudAssembly.
String	getAccount() Account where the stack should be deployed.
List<StackAsset>	getAssets() Assets referenced by this stack.
String	getAssumeRoleArn() Role to assume before deploying this stack.
List<Step>	getChangeSet() Steps that take place after stack is prepared but before stack deploys.
String	getConstructPath() Construct path for this stack.
String	getExecutionRoleArn() Execution role to pass to CloudFormation.
List<Step>	getPost() Steps to execute after stack deploys.
List<Step>	getPre() Steps that take place before stack is prepared.
String	getRegion() Region where the stack should be deployed.
String	getStackArtifactId() Artifact ID for this stack.
List<StackDeployment>	getStackDependencies() Other stacks this stack depends on.
String	getStackName() Name for this stack.
Map<String,String>	getTags() Tags to apply to the stack.
StackAsset	getTemplateAsset() The asset that represents the CloudFormation template for this stack.
String	getTemplateUrl() The S3 URL which points to the template asset location in the publishing bucket.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

StackDeployment

protected StackDeployment(software.amazon.jsii.JsiiObjectRef objRef)

StackDeployment

protected StackDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromArtifact

@Stability(value=Stable)
 @NotNull
public static StackDeployment fromArtifact(@NotNull
                                                                              CloudFormationStackArtifact stackArtifact)

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

Parameters:

stackArtifact - This parameter is required.

addStackDependency

@Stability(value=Stable)
public void addStackDependency(@NotNull
                                                        StackDeployment stackDeployment)

Add a dependency on another stack.

Parameters:

stackDeployment - This parameter is required.

addStackSteps

@Stability(value=Stable)
public void addStackSteps(@NotNull
                                                   List<Step> pre,
                                                   @NotNull
                                                   List<Step> changeSet,
                                                   @NotNull
                                                   List<Step> post)

Adds steps to each phase of the stack.

Parameters:

pre - steps executed before stack.prepare. This parameter is required.

changeSet - steps executed after stack.prepare and before stack.deploy. This parameter is required.

post - steps executed after stack.deploy. This parameter is required.

getAbsoluteTemplatePath

@Stability(value=Stable)
 @NotNull
public String getAbsoluteTemplatePath()

Template path on disk to CloudAssembly.

getAssets

@Stability(value=Stable)
 @NotNull
public List<StackAsset> getAssets()

Assets referenced by this stack.

getChangeSet

@Stability(value=Stable)
 @NotNull
public List<Step> getChangeSet()

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

Your pipeline engine may not disable prepareStep.

getConstructPath

@Stability(value=Stable)
 @NotNull
public String getConstructPath()

Construct path for this stack.

getPost

@Stability(value=Stable)
 @NotNull
public List<Step> getPost()

Steps to execute after stack deploys.

getPre

@Stability(value=Stable)
 @NotNull
public List<Step> getPre()

Steps that take place before stack is prepared.

If your pipeline engine disables 'prepareStep', then this will happen before stack deploys

getStackArtifactId

@Stability(value=Stable)
 @NotNull
public String getStackArtifactId()

Artifact ID for this stack.

getStackDependencies

@Stability(value=Stable)
 @NotNull
public List<StackDeployment> getStackDependencies()

Other stacks this stack depends on.

getStackName

@Stability(value=Stable)
 @NotNull
public String getStackName()

Name for this stack.

getTags

@Stability(value=Stable)
 @NotNull
public Map<String,String> getTags()

Tags to apply to the stack.

getAccount

@Stability(value=Stable)
 @Nullable
public String getAccount()

Account where the stack should be deployed.

Default: - Pipeline account

getAssumeRoleArn

@Stability(value=Stable)
 @Nullable
public String getAssumeRoleArn()

Role to assume before deploying this stack.

Default: - Don't assume any role

getExecutionRoleArn

@Stability(value=Stable)
 @Nullable
public String getExecutionRoleArn()

Execution role to pass to CloudFormation.

Default: - No execution role

getRegion

@Stability(value=Stable)
 @Nullable
public String getRegion()

Region where the stack should be deployed.

Default: - Pipeline region

getTemplateAsset

@Stability(value=Stable)
 @Nullable
public StackAsset getTemplateAsset()

The asset that represents the CloudFormation template for this stack.

getTemplateUrl

@Stability(value=Stable)
 @Nullable
public String getTemplateUrl()

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

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