@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:42.852Z") @Stability(value=Stable) public interface AwsCloudFormationStackProperties extends software.amazon.jsii.JsiiSerializable
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloudassembly.schema.*;
AwsCloudFormationStackProperties awsCloudFormationStackProperties = AwsCloudFormationStackProperties.builder()
.templateFile("templateFile")
// the properties below are optional
.assumeRoleArn("assumeRoleArn")
.assumeRoleExternalId("assumeRoleExternalId")
.bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
.cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
.lookupRole(BootstrapRole.builder()
.arn("arn")
// the properties below are optional
.assumeRoleExternalId("assumeRoleExternalId")
.bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
.requiresBootstrapStackVersion(123)
.build())
.parameters(Map.of(
"parametersKey", "parameters"))
.requiresBootstrapStackVersion(123)
.stackName("stackName")
.stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
.tags(Map.of(
"tagsKey", "tags"))
.terminationProtection(false)
.validateOnSynth(false)
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
AwsCloudFormationStackProperties.Builder
A builder for
AwsCloudFormationStackProperties |
static class |
AwsCloudFormationStackProperties.Jsii$Proxy
An implementation for
AwsCloudFormationStackProperties |
| Modifier and Type | Method and Description |
|---|---|
static AwsCloudFormationStackProperties.Builder |
builder() |
default String |
getAssumeRoleArn()
The role that needs to be assumed to deploy the stack.
|
default String |
getAssumeRoleExternalId()
External ID to use when assuming role for cloudformation deployments.
|
default String |
getBootstrapStackVersionSsmParameter()
SSM parameter where the bootstrap stack version number can be found.
|
default String |
getCloudFormationExecutionRoleArn()
The role that is passed to CloudFormation to execute the change set.
|
default BootstrapRole |
getLookupRole()
The role to use to look up values from the target AWS account.
|
default Map<String,String> |
getParameters()
Values for CloudFormation stack parameters that should be passed when the stack is deployed.
|
default Number |
getRequiresBootstrapStackVersion()
Version of bootstrap stack required to deploy this stack.
|
default String |
getStackName()
The name to use for the CloudFormation stack.
|
default String |
getStackTemplateAssetObjectUrl()
If the stack template has already been included in the asset manifest, its asset URL.
|
default Map<String,String> |
getTags()
Values for CloudFormation stack tags that should be passed when the stack is deployed.
|
String |
getTemplateFile()
A file relative to the assembly root which contains the CloudFormation template for this stack.
|
default Boolean |
getTerminationProtection()
Whether to enable termination protection for this stack.
|
default Boolean |
getValidateOnSynth()
Whether this stack should be validated by the CLI after synthesis.
|
@Stability(value=Stable) @NotNull String getTemplateFile()
@Stability(value=Stable) @Nullable default String getAssumeRoleArn()
Default: - No role is assumed (current credentials are used)
@Stability(value=Stable) @Nullable default String getAssumeRoleExternalId()
Default: - No external ID
@Stability(value=Stable) @Nullable default String getBootstrapStackVersionSsmParameter()
Only used if requiresBootstrapStackVersion is set.
Default: - Bootstrap stack version number looked up
@Stability(value=Stable) @Nullable default String getCloudFormationExecutionRoleArn()
Default: - No role is passed (currently assumed role/credentials are used)
@Stability(value=Stable) @Nullable default BootstrapRole getLookupRole()
Default: - No role is assumed (current credentials are used)
@Stability(value=Stable) @Nullable default Map<String,String> getParameters()
Default: - No parameters
@Stability(value=Stable) @Nullable default Number getRequiresBootstrapStackVersion()
Default: - No bootstrap stack required
@Stability(value=Stable) @Nullable default String getStackName()
Default: - name derived from artifact ID
@Stability(value=Stable) @Nullable default String getStackTemplateAssetObjectUrl()
Default: - Not uploaded yet, upload just before deploying
@Stability(value=Stable) @Nullable default Map<String,String> getTags()
Default: - No tags
@Stability(value=Stable) @Nullable default Boolean getTerminationProtection()
Default: false
@Stability(value=Stable) @Nullable default Boolean getValidateOnSynth()
Default: - false
@Stability(value=Stable) static AwsCloudFormationStackProperties.Builder builder()
Copyright © 2022. All rights reserved.