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

experimental

Parameters
Stability

experimental

Methods

find_metadata_by_type(type)
Parameters

type (str) –

Return type

List[MetadataEntryResult]

Returns

all the metadata entries of a specific type in this artifact.

Stability

experimental

Attributes

assembly

experimental

Type

stability

Return type

CloudAssembly

assets

(experimental) Any assets associated with this stack.

Stability

experimental

Return type

List[Union[FileAssetMetadataEntry, ContainerImageAssetMetadataEntry]]

assume_role_arn

(experimental) The role that needs to be assumed to deploy the stack.

Default
  • No role is assumed (current credentials are used)

Stability

experimental

Return type

Optional[str]

cloud_formation_execution_role_arn

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

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

Stability

experimental

Return type

Optional[str]

dependencies

(experimental) Returns all the artifacts that this artifact depends on.

Stability

experimental

Return type

List[CloudArtifact]

display_name

(experimental) 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

experimental

Return type

str

environment

(experimental) The environment into which to deploy this artifact.

Stability

experimental

Return type

Environment

id

experimental

Type

stability

Return type

str

manifest

(experimental) The artifact’s manifest.

Stability

experimental

Return type

ArtifactManifest

messages

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

Stability

experimental

Return type

List[SynthesisMessage]

name

(deprecated) The physical name of this stack.

Deprecated

renamed to stackName

Stability

deprecated

Return type

str

original_name

(experimental) The original name as defined in the CDK app.

Stability

experimental

Return type

str

parameters

(experimental) CloudFormation parameters to pass to the stack.

Stability

experimental

Return type

Mapping[str, str]

requires_bootstrap_stack_version

(experimental) Version of bootstrap stack required to deploy this stack.

Default
  • No bootstrap stack required

Stability

experimental

Return type

Union[int, float, None]

stack_name

(experimental) The physical name of this stack.

Stability

experimental

Return type

str

stack_template_asset_object_url

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

Default
  • Not uploaded yet, upload just before deploying

Stability

experimental

Return type

Optional[str]

tags

(experimental) CloudFormation tags to pass to the stack.

Stability

experimental

Return type

Mapping[str, str]

template

(experimental) The CloudFormation template for this stack.

Stability

experimental

Return type

Any

template_file

(experimental) The file name of the template.

Stability

experimental

Return type

str

template_full_path

(experimental) Full path to the template file.

Stability

experimental

Return type

str

termination_protection

(experimental) Whether termination protection is enabled for this stack.

Stability

experimental

Return type

Optional[bool]

Static Methods

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

(experimental) 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 type

Optional[CloudArtifact]

Returns

the CloudArtifact that matches the artifact type or undefined if it’s an artifact type that is unrecognized by this module.

Stability

experimental