software.amazon.awscdk.cxapi

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.895Z")
 @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.cxapi.*;
 AwsCloudFormationStackProperties awsCloudFormationStackProperties = AwsCloudFormationStackProperties.builder()
         .templateFile("templateFile")
         // the properties below are optional
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .stackName("stackName")
         .terminationProtection(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 Map<String,String>	getParameters() Values for CloudFormation stack parameters that should be passed when the stack is deployed.
default String	getStackName() The name to use for the CloudFormation stack.
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.

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.

getParameters

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

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

getStackName

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

The name to use for the CloudFormation stack.

Default: - name derived from artifact ID

getTerminationProtection

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

Whether to enable termination protection for this stack.

Default: false

builder

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

Returns:

a AwsCloudFormationStackProperties.Builder of AwsCloudFormationStackProperties