aws-cdk-lib.cx_api.AwsCloudFormationStackProperties

interface AwsCloudFormationStackProperties

LanguageType name
.NETAmazon.CDK.CXAPI.AwsCloudFormationStackProperties
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cxapi#AwsCloudFormationStackProperties
Javasoftware.amazon.awscdk.cxapi.AwsCloudFormationStackProperties
Pythonaws_cdk.cx_api.AwsCloudFormationStackProperties
TypeScript (source)aws-cdk-lib » cx_api » 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 { cx_api } from 'aws-cdk-lib';
const awsCloudFormationStackProperties: cx_api.AwsCloudFormationStackProperties = {
  templateFile: 'templateFile',

  // the properties below are optional
  parameters: {
    parametersKey: 'parameters',
  },
  stackName: 'stackName',
  terminationProtection: false,
};

Properties

NameTypeDescription
templateFilestringA file relative to the assembly root which contains the CloudFormation template for this stack.
parameters?{ [string]: string }Values for CloudFormation stack parameters that should be passed when the stack is deployed.
stackName?stringThe name to use for the CloudFormation stack.
terminationProtection?booleanWhether to enable termination protection for this stack.

templateFile

Type: string

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


parameters?

Type: { [string]: string } (optional)

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


stackName?

Type: string (optional, default: name derived from artifact ID)

The name to use for the CloudFormation stack.


terminationProtection?

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.