CloudAssemblyBuilder

class aws_cdk.cx_api.CloudAssemblyBuilder(outdir=None, *, asset_outdir=None)

Bases: object

(experimental) Can be used to build a cloud assembly.

Stability

experimental

(experimental) Initializes a cloud assembly builder.

Parameters
  • outdir (Optional[str]) – The output directory, uses temporary directory if undefined.

  • asset_outdir (Optional[str]) – (experimental) Use the given asset output directory. Default: - Same as the manifest outdir

Stability

experimental

Methods

add_artifact(id, *, type, dependencies=None, environment=None, metadata=None, properties=None)

(experimental) Adds an artifact into the cloud assembly.

Parameters
  • id (str) – The ID of the artifact.

  • 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.

Stability

experimental

Return type

None

add_missing(*, key, props, provider)

(experimental) Reports that some context is missing in order for this cloud assembly to be fully synthesized.

Parameters
Stability

experimental

Return type

None

build_assembly(*, runtime_info=None)

(experimental) Finalizes the cloud assembly into the output directory returns a CloudAssembly object that can be used to inspect the assembly.

Parameters

runtime_info (Optional[RuntimeInfo]) – (deprecated) Include the specified runtime information (module versions) in manifest. Default: - if this option is not specified, runtime info will not be included

Stability

experimental

Return type

CloudAssembly

create_nested_assembly(artifact_id, display_name)

(experimental) Creates a nested cloud assembly.

Parameters
  • artifact_id (str) –

  • display_name (str) –

Stability

experimental

Return type

CloudAssemblyBuilder

Attributes

asset_outdir

(experimental) The directory where assets of this Cloud Assembly should be stored.

Stability

experimental

Return type

str

outdir

(experimental) The root directory of the resulting cloud assembly.

Stability

experimental

Return type

str