AssemblyManifest

class aws_cdk.cloud_assembly_schema.AssemblyManifest(*, version, artifacts=None, minimum_cli_version=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.

• minimum_cli_version (Optional[str]) – Required CLI version, if available. If the manifest producer knows, it can put the minimum version of the CLI here that supports reading this assembly. If set, it can be used to show a more informative error message to users. Default: - Minimum CLI version unknown

• 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

# assume_role_additional_options: Any

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
            additional_metadata_file="additionalMetadataFile",
            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_additional_options={
                    "assume_role_additional_options_key": assume_role_additional_options
                },
                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_additional_options={
                        "assume_role_additional_options_key": assume_role_additional_options
                    },
                    assume_role_external_id="assumeRoleExternalId",
                    bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                    requires_bootstrap_stack_version=123
                ),
                notification_arns=["notificationArns"],
                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
            )
        )
    },
    minimum_cli_version="minimumCliVersion",
    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
            assume_role_additional_options={
                "assume_role_additional_options_key": assume_role_additional_options
            },
            lookup_role_arn="lookupRoleArn",
            lookup_role_external_id="lookupRoleExternalId",
            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.

minimum_cli_version

Required CLI version, if available.

If the manifest producer knows, it can put the minimum version of the CLI here that supports reading this assembly.

If set, it can be used to show a more informative error message to users.

Default:

• Minimum CLI version unknown

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.

runtime

Runtime information.

Default:

• no info.

version

Protocol version.