AwsCloudFormationStackProperties¶
-
class
aws_cdk.cx_api.
AwsCloudFormationStackProperties
(*, template_file, parameters=None, stack_name=None, termination_protection=None)¶ Bases:
object
Artifact properties for CloudFormation stacks.
- Parameters
template_file (
str
) – A file relative to the assembly root which contains the CloudFormation template for this stack.parameters (
Optional
[Mapping
[str
,str
]]) – Values for CloudFormation stack parameters that should be passed when the stack is deployed.stack_name (
Optional
[str
]) – The name to use for the CloudFormation stack. Default: - name derived from artifact IDtermination_protection (
Optional
[bool
]) – Whether to enable termination protection for this stack. Default: false
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.cx_api as cx_api aws_cloud_formation_stack_properties = cx_api.AwsCloudFormationStackProperties( template_file="templateFile", # the properties below are optional parameters={ "parameters_key": "parameters" }, stack_name="stackName", termination_protection=False )
Attributes
-
parameters
¶ Values for CloudFormation stack parameters that should be passed when the stack is deployed.
- Return type
Optional
[Mapping
[str
,str
]]
-
stack_name
¶ The name to use for the CloudFormation stack.
- Default
name derived from artifact ID
- Return type
Optional
[str
]
-
template_file
¶ A file relative to the assembly root which contains the CloudFormation template for this stack.
- Return type
str
-
termination_protection
¶ Whether to enable termination protection for this stack.
- Default
false
- Return type
Optional
[bool
]