TreeCloudArtifact

class aws_cdk.cx_api.TreeCloudArtifact(assembly, name, *, type, dependencies=None, display_name=None, environment=None, metadata=None, properties=None)

Bases: CloudArtifact

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
import aws_cdk.cx_api as cx_api

# cloud_assembly: cx_api.CloudAssembly

tree_cloud_artifact = cx_api.TreeCloudArtifact(cloud_assembly, "name",
    type=cloud_assembly_schema.ArtifactType.NONE,

    # the properties below are optional
    dependencies=["dependencies"],
    display_name="displayName",
    environment="environment",
    metadata={
        "metadata_key": [cloud_assembly_schema.MetadataEntry(
            type="type",

            # the properties below are optional
            data="data",
            trace=["trace"]
        )]
    },
    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
    )
)
Parameters:
  • assembly (CloudAssembly)

  • name (str)

  • type (ArtifactType) – The type of artifact.

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

  • display_name (Optional[str]) – A string that represents this artifact. Should only be used in user interfaces. Default: - no display name

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

  • metadata (Optional[Mapping[str, Sequence[Union[MetadataEntry, Dict[str, Any]]]]]) – Associated metadata. Default: - no metadata.

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

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.

Attributes

assembly
dependencies

Returns all the artifacts that this artifact depends on.

file
hierarchical_id

An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.

Defaults to the normal id. Should only be used in user interfaces.

id
manifest

The artifact’s manifest.

messages

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

Static Methods

classmethod from_manifest(assembly, id, *, type, dependencies=None, display_name=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[Sequence[str]]) – IDs of artifacts that must be deployed before this artifact. Default: - no dependencies.

  • display_name (Optional[str]) – A string that represents this artifact. Should only be used in user interfaces. Default: - no display name

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

  • metadata (Optional[Mapping[str, Sequence[Union[MetadataEntry, Dict[str, Any]]]]]) – Associated metadata. Default: - no metadata.

  • properties (Union[AwsCloudFormationStackProperties, Dict[str, Any], 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.