StackDeployment

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.pipelines.StackDeployment

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:31.130Z")
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);

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStackDependency(StackDeployment stackDeployment)` Add a dependency on another stack.
`void`	`addStackSteps(java.util.List<Step> pre, java.util.List<Step> changeSet, java.util.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.
`java.lang.String`	`getAbsoluteTemplatePath()` Template path on disk to CloudAssembly.
`java.lang.String`	`getAccount()` Account where the stack should be deployed.
`java.util.List<StackAsset>`	`getAssets()` Assets referenced by this stack.
`java.lang.String`	`getAssumeRoleArn()` Role to assume before deploying this stack.
`java.util.List<Step>`	`getChangeSet()` Steps that take place after stack is prepared but before stack deploys.
`java.lang.String`	`getConstructPath()` Construct path for this stack.
`java.lang.String`	`getExecutionRoleArn()` Execution role to pass to CloudFormation.
`java.util.List<Step>`	`getPost()` Steps to execute after stack deploys.
`java.util.List<Step>`	`getPre()` Steps that take place before stack is prepared.
`java.lang.String`	`getRegion()` Region where the stack should be deployed.
`java.lang.String`	`getStackArtifactId()` Artifact ID for this stack.
`java.util.List<StackDeployment>`	`getStackDependencies()` Other stacks this stack depends on.
`java.lang.String`	`getStackName()` Name for this stack.
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` Tags to apply to the stack.
`StackAsset`	`getTemplateAsset()` The asset that represents the CloudFormation template for this stack.
`java.lang.String`	`getTemplateUrl()` The S3 URL which points to the template asset location in the publishing bucket.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StackDeployment
```
protected StackDeployment(software.amazon.jsii.JsiiObjectRef objRef)
```
  - StackDeployment
```
protected StackDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
- Method Detail
  - fromArtifact
```
public static StackDeployment fromArtifact(CloudFormationStackArtifact stackArtifact)
```
    Build a `StackDeployment` from a Stack Artifact in a Cloud Assembly.
    
    Parameters:
    
    stackArtifact - This parameter is required.
  - addStackDependency
```
public void addStackDependency(StackDeployment stackDeployment)
```
    Add a dependency on another stack.
    
    Parameters:
    
    stackDeployment - This parameter is required.
  - addStackSteps
```
public void addStackSteps(java.util.List<Step> pre,
                          java.util.List<Step> changeSet,
                          java.util.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
```
public java.lang.String getAbsoluteTemplatePath()
```
    Template path on disk to CloudAssembly.
  - getAssets
```
public java.util.List<StackAsset> getAssets()
```
    Assets referenced by this stack.
  - getChangeSet
```
public java.util.List<Step> getChangeSet()
```
    Steps that take place after stack is prepared but before stack deploys.
    Your pipeline engine may not disable prepareStep.
  - getConstructPath
```
public java.lang.String getConstructPath()
```
    Construct path for this stack.
  - getPost
```
public java.util.List<Step> getPost()
```
    Steps to execute after stack deploys.
  - getPre
```
public java.util.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
```
public java.lang.String getStackArtifactId()
```
    Artifact ID for this stack.
  - getStackDependencies
```
public java.util.List<StackDeployment> getStackDependencies()
```
    Other stacks this stack depends on.
  - getStackName
```
public java.lang.String getStackName()
```
    Name for this stack.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
    Tags to apply to the stack.
  - getAccount
```
public java.lang.String getAccount()
```
    Account where the stack should be deployed.
    Default: - Pipeline account
  - getAssumeRoleArn
```
public java.lang.String getAssumeRoleArn()
```
    Role to assume before deploying this stack.
    Default: - Don't assume any role
  - getExecutionRoleArn
```
public java.lang.String getExecutionRoleArn()
```
    Execution role to pass to CloudFormation.
    Default: - No execution role
  - getRegion
```
public java.lang.String getRegion()
```
    Region where the stack should be deployed.
    Default: - Pipeline region
  - getTemplateAsset
```
public StackAsset getTemplateAsset()
```
    The asset that represents the CloudFormation template for this stack.
  - getTemplateUrl
```
public java.lang.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

Class StackDeployment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackDeployment

StackDeployment

Method Detail

fromArtifact

addStackDependency

addStackSteps

getAbsoluteTemplatePath

getAssets

getChangeSet

getConstructPath

getPost

getPre

getStackArtifactId

getStackDependencies

getStackName

getTags

getAccount

getAssumeRoleArn

getExecutionRoleArn

getRegion

getTemplateAsset

getTemplateUrl