AssemblyManifest

class aws_cdk.cloud_assembly_schema.AssemblyManifest(*, version, artifacts=None, missing=None, runtime=None)

Bases: object

A manifest which describes the cloud assembly.

Parameters
  • version (str) – Protocol version.

  • artifacts (Optional[Mapping[str, Union[ArtifactManifest, Dict[str, Any]]]]) – The set of artifacts in this assembly. Default: - no artifacts.

  • missing (Optional[Sequence[Union[MissingContext, Dict[str, Any]]]]) – Missing context information. If this field has values, it means that the cloud assembly is not complete and should not be deployed. Default: - no missing context.

  • runtime (Union[RuntimeInfo, Dict[str, Any], None]) – Runtime information. Default: - no info.

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

assembly_manifest = cloud_assembly_schema.AssemblyManifest(
    version="version",

    # the properties below are optional
    artifacts={
        "artifacts_key": cloud_assembly_schema.ArtifactManifest(
            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
            )
        )
    },
    missing=[cloud_assembly_schema.MissingContext(
        key="key",
        props=cloud_assembly_schema.AmiContextQuery(
            account="account",
            filters={
                "filters_key": ["filters"]
            },
            region="region",

            # the properties below are optional
            lookup_role_arn="lookupRoleArn",
            owners=["owners"]
        ),
        provider=cloud_assembly_schema.ContextProvider.AMI_PROVIDER
    )],
    runtime=cloud_assembly_schema.RuntimeInfo(
        libraries={
            "libraries_key": "libraries"
        }
    )
)

Attributes

artifacts

The set of artifacts in this assembly.

Default
  • no artifacts.

Return type

Optional[Mapping[str, ArtifactManifest]]

missing

Missing context information.

If this field has values, it means that the cloud assembly is not complete and should not be deployed.

Default
  • no missing context.

Return type

Optional[List[MissingContext]]

runtime

Runtime information.

Default
  • no info.

Return type

Optional[RuntimeInfo]

version

Protocol version.

Return type

str