-
Interface Summary Interface Description AmiContextQuery (experimental) Query to AMI context provider.ArtifactManifest (experimental) A manifest for a single artifact within the cloud assembly.AssemblyManifest (experimental) A manifest which describes the cloud assembly.AssetManifest (experimental) Definitions for the asset manifest.AssetManifestProperties (experimental) Artifact properties for the Asset Manifest.AvailabilityZonesContextQuery (experimental) Query to availability zone context provider.AwsCloudFormationStackProperties (experimental) Artifact properties for CloudFormation stacks.AwsDestination (experimental) Destination for assets that need to be uploaded to AWS.ContainerImageAssetMetadataEntry (experimental) Metadata Entry spec for container images.DockerImageAsset (experimental) A file asset.DockerImageDestination (experimental) Where to publish docker images.DockerImageSource (experimental) Properties for how to produce a Docker image from a source.EndpointServiceAvailabilityZonesContextQuery (experimental) Query to endpoint service context provider.FileAsset (experimental) A file asset.FileAssetMetadataEntry (experimental) Metadata Entry spec for files.FileDestination (experimental) Where in S3 a file asset needs to be published.FileSource (experimental) Describe the source of a file asset.HostedZoneContextQuery (experimental) Query to hosted zone context provider.LoadBalancerContextQuery (experimental) Query input for looking up a load balancer.LoadBalancerFilter (experimental) Filters for selecting load balancers.LoadBalancerListenerContextQuery (experimental) Query input for looking up a load balancer listener.MetadataEntry (experimental) A metadata entry in a cloud assembly artifact.MissingContext (experimental) Represents a missing piece of context.NestedCloudAssemblyProperties (experimental) Artifact properties for nested cloud assemblies.RuntimeInfo (experimental) Information about the application's runtime components.SecurityGroupContextQuery (experimental) Query input for looking up a security group.SSMParameterContextQuery (experimental) Query to SSM Parameter Context Provider.Tag (experimental) Metadata Entry spec for stack tag.TreeArtifactProperties (experimental) Artifact properties for the Construct Tree Artifact.VpcContextQuery (experimental) Query input for looking up a VPC. -
Enum Summary Enum Description ArtifactMetadataEntryType (experimental) Type of artifact metadata entry.ArtifactType (experimental) Type of cloud artifact.ContextProvider (experimental) Identifier for the context provider.FileAssetPackaging (experimental) Packaging strategy for file assets.LoadBalancerListenerProtocol (experimental) The protocol for connections from clients to the load balancer.LoadBalancerType (experimental) Type of load balancer.
Package software.amazon.awscdk.cloudassembly.schema Description
Cloud Assembly Schema
---
This module is part of the AWS Cloud Development Kit project.
Cloud Assembly
The Cloud Assembly is the output of the synthesis operation. It is produced as part of the
cdk synth
command, or the app.synth() method invocation.
Its essentially a set of files and directories, one of which is the manifest.json file. It defines the set of instructions that are
needed in order to deploy the assembly directory.
For example, when
cdk deployis executed, the CLI reads this file and performs its instructions:
- Build container images.
- Upload assets.
- Deploy CloudFormation templates.
Therefore, the assembly is how the CDK class library and CDK CLI (or any other consumer) communicate. To ensure compatibility between the assembly and its consumers, we treat the manifest file as a well defined, versioned schema.
Schema
This module contains the typescript structs that comprise the manifest.json file, as well as the
generated json-schema.
Versioning
The schema version is specified in the cloud-assembly.version.json file, under the version property.
It follows semantic versioning, but with a small twist.
When we add instructions to the assembly, they are reflected in the manifest file and the json-schema accordingly. Every such instruction, is crucial for ensuring the correct deployment behavior. This means that to properly deploy a cloud assembly, consumers must be aware of every such instruction modification.
For this reason, every change to the schema, even though it might not strictly break validation of the json-schema format,
is considered major version bump.
How to consume
If you'd like to consume the schema file in order to do validations on manifest.json files,
simply download it from this repo and run it against standard json-schema validators, such as jsonschema.
Consumers must take into account the major version of the schema they are consuming. They should reject cloud assemblies
with a major version that is higher than what they expect. While schema validation might pass on such assemblies, the deployment integrity
cannot be guaranteed because some instructions will be ignored.
For example, if your consumer was built when the schema version was 2.0.0, you should reject deploying cloud assemblies with a manifest version of 3.0.0.