software.amazon.awscdk.cxapi

Interface AwsCloudFormationStackProperties

All Known Implementing Classes:

AwsCloudFormationStackProperties.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:49.120Z")
public interface AwsCloudFormationStackProperties

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 java.util.Map<java.lang.String,java.lang.String>	getParameters() Values for CloudFormation stack parameters that should be passed when the stack is deployed.
default java.lang.String	getStackName() The name to use for the CloudFormation stack.
java.lang.String	getTemplateFile() A file relative to the assembly root which contains the CloudFormation template for this stack.
default java.lang.Boolean	getTerminationProtection() Whether to enable termination protection for this stack.

Method Detail

getTemplateFile

java.lang.String getTemplateFile()

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

getParameters

default java.util.Map<java.lang.String,java.lang.String> getParameters()

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

getStackName

default java.lang.String getStackName()

The name to use for the CloudFormation stack.

Default: - name derived from artifact ID

getTerminationProtection

default java.lang.Boolean getTerminationProtection()

Whether to enable termination protection for this stack.

Default: false

builder

static AwsCloudFormationStackProperties.Builder builder()

Returns:

a AwsCloudFormationStackProperties.Builder of AwsCloudFormationStackProperties