Package software.amazon.awscdk.cxapi

Interface AwsCloudFormationStackProperties

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsCloudFormationStackProperties.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:36.781Z")
@Stability(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	Description
static final class	AwsCloudFormationStackProperties.Builder	A builder for AwsCloudFormationStackProperties
static final class	AwsCloudFormationStackProperties.Jsii$Proxy	An implementation for AwsCloudFormationStackProperties

Method Summary

Modifier and Type	Method	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 Details

getTemplateFile

@Stability(Stable)
@NotNull
String getTemplateFile()

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

getParameters

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

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

getStackName

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

The name to use for the CloudFormation stack.

Default: - name derived from artifact ID

getTerminationProtection

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

Whether to enable termination protection for this stack.

Default: false

builder

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

Returns:

a AwsCloudFormationStackProperties.Builder of AwsCloudFormationStackProperties