CloudAssemblyBuilder

Can be used to build a cloud assembly.

Initializers

import ros_cdk_cxapi
ros_cdk_cxapi.CloudAssemblyBuilder(
  outdir: str = None,
  asset_outdir: str = None,
  parent_builder: CloudAssemblyBuilder = None
)

Name	Type	Description
outdir	str	The output directory, uses temporary directory if undefined.
asset_outdir	str	Use the given asset output directory.
parent_builder	CloudAssemblyBuilder	If this builder is for a nested assembly, the parent assembly builder.

---

outdir^Optional

• Type: str

The output directory, uses temporary directory if undefined.

---

asset_outdir^Optional

• Type: str
• Default: Same as the manifest outdir

Use the given asset output directory.

---

parent_builder^Optional

• Type: CloudAssemblyBuilder
• Default: This is a root assembly

If this builder is for a nested assembly, the parent assembly builder.

---

Methods

Name	Description
add_artifact	Adds an artifact into the cloud assembly.
add_missing	Reports that some context is missing in order for this cloud assembly to be fully synthesized.
build_assembly	Finalizes the cloud assembly into the output directory returns a 'CloudAssembly' object that can be used to inspect the assembly.
create_nested_assembly	Creates a nested cloud assembly.

---

add_artifact

def add_artifact(
  id: str,
  type: ArtifactType,
  dependencies: typing.List[str] = None,
  metadata: typing.Mapping[typing.List[MetadataEntry]] = None,
  properties: typing.Union[AliyunRosStackProperties, TreeArtifactProperties, NestedCloudAssemblyProperties] = None
) -> None

Adds an artifact into the cloud assembly.

id^Required

• Type: str

The ID of the artifact.

---

type^Required

• Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.

---

dependencies^Optional

• Type: typing.List[str]
• Default: no dependencies.

IDs of artifacts that must be deployed before this artifact.

---

metadata^Optional

• Type: typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]
• Default: no metadata.

Associated metadata.

---

properties^Optional

• Type: typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]
• Default: no properties.

The set of properties for this artifact (depends on type).

---

add_missing

def add_missing(
  key: str,
  props: typing.Union[AmiContextQuery, AvailabilityZonesContextQuery, HostedZoneContextQuery, SSMParameterContextQuery, VpcContextQuery, EndpointServiceAvailabilityZonesContextQuery],
  provider: ContextProvider
) -> None

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

key^Required

• Type: str

The missing context key.

---

props^Required

• Type: typing.Union[ros_cdk_assembly_schema.AmiContextQuery, ros_cdk_assembly_schema.AvailabilityZonesContextQuery, ros_cdk_assembly_schema.HostedZoneContextQuery, ros_cdk_assembly_schema.SSMParameterContextQuery, ros_cdk_assembly_schema.VpcContextQuery, ros_cdk_assembly_schema.EndpointServiceAvailabilityZonesContextQuery]

A set of provider-specific options.

---

provider^Required

• Type: ros_cdk_assembly_schema.ContextProvider

The provider from which we expect this context key to be obtained.

---

build_assembly

def build_assembly(
  runtime_info: RuntimeInfo = None
) -> CloudAssembly

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

runtime_info^Optional

• Type: RuntimeInfo
• Default: if this option is not specified, runtime info will not be included

Include the specified runtime information (module versions) in manifest.

---

create_nested_assembly

def create_nested_assembly(
  artifact_id: str,
  display_name: str
) -> CloudAssemblyBuilder

Creates a nested cloud assembly.

artifact_id^Required

• Type: str

---

display_name^Required

• Type: str

---

Properties

Name	Type	Description
asset_outdir	str	The directory where assets of this Cloud Assembly should be stored.
outdir	str	The root directory of the resulting cloud assembly.

---

asset_outdir^Required

asset_outdir: str

• Type: str

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

---

outdir^Required

outdir: str

• Type: str

The root directory of the resulting cloud assembly.

---