ArtifactManifest¶
-
class
aws_cdk.cloud_assembly_schema.
ArtifactManifest
(*, type, dependencies=None, display_name=None, environment=None, metadata=None, properties=None)¶ Bases:
object
A manifest for a single artifact within the cloud assembly.
- Parameters
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 nameenvironment (
Optional
[str
]) – The environment into which this artifact is deployed. Default: - no envrionment.metadata (
Optional
[Mapping
[str
,Sequence
[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.
- 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 artifact_manifest = 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 ) )
Attributes
-
dependencies
¶ IDs of artifacts that must be deployed before this artifact.
- Default
no dependencies.
- Return type
Optional
[List
[str
]]
-
display_name
¶ A string that represents this artifact.
Should only be used in user interfaces.
- Default
no display name
- Return type
Optional
[str
]
-
environment
¶ The environment into which this artifact is deployed.
- Default
no envrionment.
- Return type
Optional
[str
]
-
metadata
¶ Associated metadata.
- Default
no metadata.
- Return type
Optional
[Mapping
[str
,List
[MetadataEntry
]]]
-
properties
¶ The set of properties for this artifact (depends on type).
- Default
no properties.
- Return type
Union
[AwsCloudFormationStackProperties
,AssetManifestProperties
,TreeArtifactProperties
,NestedCloudAssemblyProperties
,None
]
-
type
¶ The type of artifact.
- Return type