CloudFormationStackArtifact

class aws_cdk.cx_api.CloudFormationStackArtifact(assembly, artifact_id, *, type, dependencies=None, environment=None, metadata=None, properties=None)

Bases: aws_cdk.cx_api.CloudArtifact

stability :stability: experimental

__init__(assembly, artifact_id, *, type, dependencies=None, environment=None, metadata=None, properties=None)
Parameters

stability :stability: experimental

Return type

None

Methods

find_metadata_by_type(type)
Parameters

type (str) –

return :rtype: List[MetadataEntryResult] :return: all the metadata entries of a specific type in this artifact.

stability :stability: experimental

Attributes

assembly

stability :stability: experimental

Return type

CloudAssembly

assets

Any assets associated with this stack.

stability :stability: experimental

Return type

List[Union[FileAssetMetadataEntry, ContainerImageAssetMetadataEntry]]

assume_role_arn

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

default :default: - No role is assumed (current credentials are used)

stability :stability: experimental

Return type

Optional[str]

cloud_formation_execution_role_arn

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

default :default: - No role is passed (currently assumed role/credentials are used)

stability :stability: experimental

Return type

Optional[str]

dependencies

Returns all the artifacts that this artifact depends on.

stability :stability: experimental

Return type

List[CloudArtifact]

display_name

A string that represents this stack.

Should only be used in user interfaces. If the stackName and artifactId are the same, it will just return that. Otherwise, it will return something like ” ()”

stability :stability: experimental

Return type

str

environment

The environment into which to deploy this artifact.

stability :stability: experimental

Return type

Environment

id

stability :stability: experimental

Return type

str

manifest

The artifact’s manifest.

stability :stability: experimental

Return type

ArtifactManifest

messages

The set of messages extracted from the artifact’s metadata.

stability :stability: experimental

Return type

List[SynthesisMessage]

name

The physical name of this stack.

deprecated :deprecated: renamed to stackName

stability :stability: deprecated

Return type

str

original_name

The original name as defined in the CDK app.

stability :stability: experimental

Return type

str

parameters

CloudFormation parameters to pass to the stack.

stability :stability: experimental

Return type

Mapping[str, str]

requires_bootstrap_stack_version

Version of bootstrap stack required to deploy this stack.

default :default: - No bootstrap stack required

stability :stability: experimental

Return type

Union[int, float, None]

stack_name

The physical name of this stack.

stability :stability: experimental

Return type

str

stack_template_asset_object_url

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

default :default: - Not uploaded yet, upload just before deploying

stability :stability: experimental

Return type

Optional[str]

template

The CloudFormation template for this stack.

stability :stability: experimental

Return type

Any

template_file

The file name of the template.

stability :stability: experimental

Return type

str

termination_protection

Whether termination protection is enabled for this stack.

stability :stability: experimental

Return type

Optional[bool]

Static Methods

classmethod from_manifest(assembly, id, *, type, dependencies=None, environment=None, metadata=None, properties=None)

Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

Parameters
  • assembly (CloudAssembly) – The cloud assembly from which to load the artifact.

  • id (str) – The artifact ID.

  • type (ArtifactType) – The type of artifact.

  • dependencies (Optional[List[str]]) – IDs of artifacts that must be deployed before this artifact. Default: - no dependencies.

  • environment (Optional[str]) – The environment into which this artifact is deployed. Default: - no envrionment.

  • metadata (Optional[Mapping[str, List[MetadataEntry]]]) – Associated metadata. Default: - no metadata.

  • properties (Union[AwsCloudFormationStackProperties, AssetManifestProperties, TreeArtifactProperties, NestedCloudAssemblyProperties, None]) – The set of properties for this artifact (depends on type). Default: - no properties.

return :rtype: Optional[CloudArtifact] :return: the CloudArtifact that matches the artifact type or undefined if it’s an artifact type that is unrecognized by this module.

stability :stability: experimental