AWS CDK Reference

Appearance

v2.275.0

AwsCloudFormationStackProperties Struct ​

Artifact properties for CloudFormation stacks.

Source
cx-api/lib/legacy-moved.ts
Type last changed
v2.238.0 · 9 Feb 2026

Example ​

ts
// 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 ​

parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string#
Values for CloudFormation stack parameters that should be passed when the stack is deployed.
stackNameoptionalstringstack_nameoptionalstrstackNameoptionalStringStackNameoptionalstringStackNameoptional*string#
The name to use for the CloudFormation stack.

Default: name derived from artifact ID

templateFilestringtemplate_filestrtemplateFileStringTemplateFilestringTemplateFile*stringrequired#
A file relative to the assembly root which contains the CloudFormation template for this stack.
terminationProtectionoptionalbooleantermination_protectionoptionalboolterminationProtectionoptionalBooleanTerminationProtectionoptionalboolTerminationProtectionoptional*bool= false#
Whether to enable termination protection for this stack.