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, lookup_role=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)
lookup_role (Union[BootstrapRole, Dict[str, Any], None]) – The role to use to look up values from the target AWS account. Default: - No role is assumed (current 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

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.cloud_assembly_schema as cloud_assembly_schema

aws_cloud_formation_stack_properties = cloud_assembly_schema.AwsCloudFormationStackProperties(
    template_file="templateFile",

    # the properties below are optional
    assume_role_arn="assumeRoleArn",
    assume_role_external_id="assumeRoleExternalId",
    bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
    cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
    lookup_role=cloud_assembly_schema.BootstrapRole(
        arn="arn",

        # the properties below are optional
        assume_role_external_id="assumeRoleExternalId",
        bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
        requires_bootstrap_stack_version=123
    ),
    parameters={
        "parameters_key": "parameters"
    },
    requires_bootstrap_stack_version=123,
    stack_name="stackName",
    stack_template_asset_object_url="stackTemplateAssetObjectUrl",
    tags={
        "tags_key": "tags"
    },
    termination_protection=False,
    validate_on_synth=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)

assume_role_external_id

External ID to use when assuming role for cloudformation deployments.

Default:

No external ID

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

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)

lookup_role

The role to use to look up values from the target AWS account.

Default:

No role is assumed (current credentials are used)

parameters

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

Default:

No parameters

requires_bootstrap_stack_version

Version of bootstrap stack required to deploy this stack.

Default:

No bootstrap stack required

stack_name

The name to use for the CloudFormation stack.

Default:

name derived from artifact ID

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

tags

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

Default:

No tags

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

termination_protection

Whether to enable termination protection for this stack.

Default:: false

validate_on_synth

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

Default:

false