software.amazon.awscdk.pipelines

Interface StackDeploymentProps

All Known Implementing Classes:

StackDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:37.730Z")
public interface StackDeploymentProps

Properties for a `StackDeployment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.pipelines.*;
 StackDeploymentProps stackDeploymentProps = StackDeploymentProps.builder()
         .absoluteTemplatePath("absoluteTemplatePath")
         .constructPath("constructPath")
         .stackArtifactId("stackArtifactId")
         .stackName("stackName")
         // the properties below are optional
         .account("account")
         .assets(List.of(StackAsset.builder()
                 .assetId("assetId")
                 .assetManifestPath("assetManifestPath")
                 .assetSelector("assetSelector")
                 .assetType(AssetType.FILE)
                 .isTemplate(false)
                 // the properties below are optional
                 .assetPublishingRoleArn("assetPublishingRoleArn")
                 .build()))
         .assumeRoleArn("assumeRoleArn")
         .executionRoleArn("executionRoleArn")
         .region("region")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .templateS3Uri("templateS3Uri")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StackDeploymentProps.Builder A builder for StackDeploymentProps
static class	StackDeploymentProps.Jsii$Proxy An implementation for StackDeploymentProps

Method Summary

Modifier and Type	Method and Description
static StackDeploymentProps.Builder	builder()
java.lang.String	getAbsoluteTemplatePath() Template path on disk to cloud assembly (cdk.out).
default java.lang.String	getAccount() Account where the stack should be deployed.
default java.util.List<StackAsset>	getAssets() Assets referenced by this stack.
default java.lang.String	getAssumeRoleArn() Role to assume before deploying this stack.
java.lang.String	getConstructPath() Construct path for this stack.
default java.lang.String	getExecutionRoleArn() Execution role to pass to CloudFormation.
default java.lang.String	getRegion() Region where the stack should be deployed.
java.lang.String	getStackArtifactId() Artifact ID for this stack.
java.lang.String	getStackName() Name for this stack.
default java.util.Map<java.lang.String,java.lang.String>	getTags() Tags to apply to the stack.
default java.lang.String	getTemplateS3Uri() The S3 URL which points to the template asset location in the publishing bucket.

Method Detail

getAbsoluteTemplatePath

java.lang.String getAbsoluteTemplatePath()

Template path on disk to cloud assembly (cdk.out).

getConstructPath

java.lang.String getConstructPath()

Construct path for this stack.

getStackArtifactId

java.lang.String getStackArtifactId()

Artifact ID for this stack.

getStackName

java.lang.String getStackName()

Name for this stack.

getAccount

default java.lang.String getAccount()

Account where the stack should be deployed.

Default: - Pipeline account

getAssets

default java.util.List<StackAsset> getAssets()

Assets referenced by this stack.

Default: - No assets

getAssumeRoleArn

default java.lang.String getAssumeRoleArn()

Role to assume before deploying this stack.

Default: - Don't assume any role

getExecutionRoleArn

default java.lang.String getExecutionRoleArn()

Execution role to pass to CloudFormation.

Default: - No execution role

getRegion

default java.lang.String getRegion()

Region where the stack should be deployed.

Default: - Pipeline region

getTags

default java.util.Map<java.lang.String,java.lang.String> getTags()

Tags to apply to the stack.

Default: - No tags

getTemplateS3Uri

default java.lang.String getTemplateS3Uri()

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

Default: - Stack template is not published

builder

static StackDeploymentProps.Builder builder()

Returns:

a StackDeploymentProps.Builder of StackDeploymentProps