Package software.amazon.awscdk.pipelines

Interface StackDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StackDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.891Z")
@Stability(Stable)
public interface StackDeploymentProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	StackDeploymentProps.Builder	A builder for StackDeploymentProps
static final class	StackDeploymentProps.Jsii$Proxy	An implementation for StackDeploymentProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAbsoluteTemplatePath

@Stability(Stable)
@NotNull
String getAbsoluteTemplatePath()

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

getConstructPath

@Stability(Stable)
@NotNull
String getConstructPath()

Construct path for this stack.

getStackArtifactId

@Stability(Stable)
@NotNull
String getStackArtifactId()

Artifact ID for this stack.

getStackName

@Stability(Stable)
@NotNull
String getStackName()

Name for this stack.

getAccount

@Stability(Stable)
@Nullable
default String getAccount()

Account where the stack should be deployed.

Default: - Pipeline account

getAssets

@Stability(Stable)
@Nullable
default List<StackAsset> getAssets()

Assets referenced by this stack.

Default: - No assets

getAssumeRoleArn

@Stability(Stable)
@Nullable
default String getAssumeRoleArn()

Role to assume before deploying this stack.

Default: - Don't assume any role

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

Execution role to pass to CloudFormation.

Default: - No execution role

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

Region where the stack should be deployed.

Default: - Pipeline region

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Tags to apply to the stack.

Default: - No tags

getTemplateS3Uri

@Stability(Stable)
@Nullable
default String getTemplateS3Uri()

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

Default: - Stack template is not published

builder

@Stability(Stable)
static StackDeploymentProps.Builder builder()

Returns:

a StackDeploymentProps.Builder of StackDeploymentProps