software.amazon.awscdk.cloudassembly.schema

Interface AwsCloudFormationStackProperties

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsCloudFormationStackProperties.Jsii$Proxy

@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

Artifact properties for CloudFormation stacks.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTemplateFile

@Stability(value=Stable)
 @NotNull
String getTemplateFile()

A file relative to the assembly root which contains the CloudFormation template for this stack.

getAssumeRoleArn

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

The role that needs to be assumed to deploy the stack.

Default: - No role is assumed (current credentials are used)

getAssumeRoleExternalId

@Stability(value=Stable)
 @Nullable
default String getAssumeRoleExternalId()

External ID to use when assuming role for cloudformation deployments.

Default: - No external ID

getBootstrapStackVersionSsmParameter

@Stability(value=Stable)
 @Nullable
default String getBootstrapStackVersionSsmParameter()

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

• If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
• If this value is set, the bootstrap stack can have any name because we won't need to look it up.

Default: - Bootstrap stack version number looked up

getCloudFormationExecutionRoleArn

@Stability(value=Stable)
 @Nullable
default String getCloudFormationExecutionRoleArn()

The role that is passed to CloudFormation to execute the change set.

Default: - No role is passed (currently assumed role/credentials are used)

getLookupRole

@Stability(value=Stable)
 @Nullable
default BootstrapRole getLookupRole()

The role to use to look up values from the target AWS account.

Default: - No role is assumed (current credentials are used)

getParameters

@Stability(value=Stable)
 @Nullable
default Map<String,String> getParameters()

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

Default: - No parameters

getRequiresBootstrapStackVersion

@Stability(value=Stable)
 @Nullable
default Number getRequiresBootstrapStackVersion()

Version of bootstrap stack required to deploy this stack.

Default: - No bootstrap stack required

getStackName

@Stability(value=Stable)
 @Nullable
default String getStackName()

The name to use for the CloudFormation stack.

Default: - name derived from artifact ID

getStackTemplateAssetObjectUrl

@Stability(value=Stable)
 @Nullable
default String getStackTemplateAssetObjectUrl()

If the stack template has already been included in the asset manifest, its asset URL.

Default: - Not uploaded yet, upload just before deploying

getTags

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

Values for CloudFormation stack tags that should be passed when the stack is deployed.

Default: - No tags

getTerminationProtection

@Stability(value=Stable)
 @Nullable
default Boolean getTerminationProtection()

Whether to enable termination protection for this stack.

Default: false

getValidateOnSynth

@Stability(value=Stable)
 @Nullable
default Boolean getValidateOnSynth()

Whether this stack should be validated by the CLI after synthesis.

Default: - false

builder

@Stability(value=Stable)
static AwsCloudFormationStackProperties.Builder builder()

Returns:

a AwsCloudFormationStackProperties.Builder of AwsCloudFormationStackProperties