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.106.0 (build e852934)",
date="2025-02-06T22:16:04.745Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forStackDeploymentProps
static final class
An implementation forStackDeploymentProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic StackDeploymentProps.Builder
builder()
Template path on disk to cloud assembly (cdk.out).default String
Account where the stack should be deployed.default List<StackAsset>
Assets referenced by this stack.default String
Role to assume before deploying this stack.Construct path for this stack.default String
Execution role to pass to CloudFormation.default String
Region where the stack should be deployed.Artifact ID for this stack.Name for this stack.getTags()
Tags to apply to the stack.default String
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
Template path on disk to cloud assembly (cdk.out). -
getConstructPath
Construct path for this stack. -
getStackArtifactId
Artifact ID for this stack. -
getStackName
Name for this stack. -
getAccount
Account where the stack should be deployed.Default: - Pipeline account
-
getAssets
Assets referenced by this stack.Default: - No assets
-
getAssumeRoleArn
Role to assume before deploying this stack.Default: - Don't assume any role
-
getExecutionRoleArn
Execution role to pass to CloudFormation.Default: - No execution role
-
getRegion
Region where the stack should be deployed.Default: - Pipeline region
-
getTags
Tags to apply to the stack.Default: - No tags
-
getTemplateS3Uri
The S3 URL which points to the template asset location in the publishing bucket.Default: - Stack template is not published
-
builder
- Returns:
- a
StackDeploymentProps.Builder
ofStackDeploymentProps
-