AwsCloudFormationStackProperties

class aws_cdk.cloud_assembly_schema.AwsCloudFormationStackProperties(*, template_file, assume_role_arn=None, assume_role_external_id=None, bootstrap_stack_version_ssm_parameter=None, cloud_formation_execution_role_arn=None, parameters=None, requires_bootstrap_stack_version=None, stack_name=None, stack_template_asset_object_url=None, tags=None, termination_protection=None, validate_on_synth=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.

  • assume_role_arn (Optional[str]) – The role that needs to be assumed to deploy the stack. Default: - No role is assumed (current credentials are used)

  • assume_role_external_id (Optional[str]) – External ID to use when assuming role for cloudformation deployments. Default: - No external ID

  • bootstrap_stack_version_ssm_parameter (Optional[str]) – SSM parameter where the bootstrap stack version number can be found. Only used if requiresBootstrapStackVersion is set. - If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs. - If this value is set, the bootstrap stack can have any name because we won’t need to look it up. Default: - Bootstrap stack version number looked up

  • cloud_formation_execution_role_arn (Optional[str]) – The role that is passed to CloudFormation to execute the change set. Default: - No role is passed (currently assumed role/credentials are used)

  • parameters (Optional[Mapping[str, str]]) – Values for CloudFormation stack parameters that should be passed when the stack is deployed. Default: - No parameters

  • requires_bootstrap_stack_version (Union[int, float, None]) – Version of bootstrap stack required to deploy this stack. Default: - No bootstrap stack required

  • stack_name (Optional[str]) – The name to use for the CloudFormation stack. Default: - name derived from artifact ID

  • stack_template_asset_object_url (Optional[str]) – If the stack template has already been included in the asset manifest, its asset URL. Default: - Not uploaded yet, upload just before deploying

  • tags (Optional[Mapping[str, str]]) – Values for CloudFormation stack tags that should be passed when the stack is deployed. Default: - No tags

  • termination_protection (Optional[bool]) – Whether to enable termination protection for this stack. Default: false

  • validate_on_synth (Optional[bool]) – Whether this stack should be validated by the CLI after synthesis. Default: - false

Attributes

assume_role_arn

The role that needs to be assumed to deploy the stack.

Default

  • No role is assumed (current credentials are used)

Return type

Optional[str]

assume_role_external_id

External ID to use when assuming role for cloudformation deployments.

Default

  • No external ID

Return type

Optional[str]

bootstrap_stack_version_ssm_parameter

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

  • If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.

  • If this value is set, the bootstrap stack can have any name because we won’t need to look it up.

Default

  • Bootstrap stack version number looked up

Return type

Optional[str]

cloud_formation_execution_role_arn

The role that is passed to CloudFormation to execute the change set.

Default

  • No role is passed (currently assumed role/credentials are used)

Return type

Optional[str]

parameters

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

Default

  • No parameters

Return type

Optional[Mapping[str, str]]

requires_bootstrap_stack_version

Version of bootstrap stack required to deploy this stack.

Default

  • No bootstrap stack required

Return type

Union[int, float, None]

stack_name

The name to use for the CloudFormation stack.

Default

  • name derived from artifact ID

Return type

Optional[str]

stack_template_asset_object_url

If the stack template has already been included in the asset manifest, its asset URL.

Default

  • Not uploaded yet, upload just before deploying

Return type

Optional[str]

tags

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

Default

  • No tags

Return type

Optional[Mapping[str, 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]

validate_on_synth

Whether this stack should be validated by the CLI after synthesis.

Default

  • false

Return type

Optional[bool]