aws-cdk-lib.cloud_assembly_schema

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 deploy is 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 my the major version of the package release. 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. All changes that do not impact the schema are considered a minor 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.

Contributing

The source code for this file has been moved to CDKLabs.

See Contribution Guide

Types

Name	Kind	Summary
AmiContextQuery	Struct	Query to AMI context provider.
ArtifactManifest	Struct	A manifest for a single artifact within the cloud assembly.
ArtifactMetadataEntryType	Enum	Type of artifact metadata entry.
ArtifactType	Enum	Type of cloud artifact.
AssemblyManifest	Struct	A manifest which describes the cloud assembly.
AssetManifest	Struct	Definitions for the asset manifest.
AssetManifestOptions	Struct	Configuration options for the Asset Manifest.
AssetManifestProperties	Struct	Artifact properties for the Asset Manifest.
AvailabilityZonesContextQuery	Struct	Query to availability zone context provider.
AwsCloudFormationStackProperties	Struct	Artifact properties for CloudFormation stacks.
AwsDestination	Struct	Destination for assets that need to be uploaded to AWS.
BootstrapRole	Struct	Information needed to access an IAM role created as part of the bootstrap process.
CcApiContextQuery	Struct	Query input for lookup up CloudFormation resources using CC API.
CdkCommand	Struct	Represents a cdk command i.e. synth, deploy, & destroy.
CdkCommands	Struct	Options for specific cdk commands that are run as part of the integration test workflow.
CloudFormationResourceJson	Struct	A node in the construct creation stack trace.
ContainerImageAssetCacheOption	Struct	Options for configuring the Docker cache backend.
ContainerImageAssetMetadataEntry	Struct	Metadata Entry spec for container images.
ContextLookupRoleOptions	Struct	Options for context lookup roles.
ContextProvider	Enum	Identifier for the context provider.
DefaultCdkOptions	Struct	Default CDK CLI options that apply to all commands.
DeployCommand	Struct	Represents a cdk deploy command.
DeployOptions	Struct	Options to use with cdk deploy.
DestroyCommand	Struct	Represents a cdk destroy command.
DestroyOptions	Struct	Options to use with cdk destroy.
DockerCacheOption	Struct	Options for configuring the Docker cache backend.
DockerImageAsset	Struct	A file asset.
DockerImageDestination	Struct	Where to publish docker images.
DockerImageSource	Struct	Properties for how to produce a Docker image from a source.
EndpointServiceAvailabilityZonesContextQuery	Struct	Query to endpoint service context provider.
FeatureFlag	Struct	A single feature flag.
FeatureFlagReportProperties	Struct	Artifact properties for a feature flag report.
FileAsset	Struct	A file asset.
FileAssetMetadataEntry	Struct	Metadata Entry spec for files.
FileAssetPackaging	Enum	Packaging strategy for file assets.
FileDestination	Struct	Where in S3 a file asset needs to be published.
FileSource	Struct	Describe the source of a file asset.
Hooks	Struct	Commands to run at predefined points during the integration test workflow.
HostedZoneContextQuery	Struct	Query to hosted zone context provider.
ICloudAssembly	Interface	Interoperable representation of a deployable cloud application.
IntegManifest	Struct	Definitions for the integration testing manifest.
KeyContextQuery	Struct	Query input for looking up a KMS Key.
LoadBalancerContextQuery	Struct	Query input for looking up a load balancer.
LoadBalancerFilter	Struct	Filters for selecting load balancers.
LoadBalancerListenerContextQuery	Struct	Query input for looking up a load balancer listener.
LoadBalancerListenerProtocol	Enum	The protocol for connections from clients to the load balancer.
LoadBalancerType	Enum	Type of load balancer.
LoadManifestOptions	Struct	Options for the loadManifest operation.
Manifest	Class	Protocol utility class.
MetadataEntry	Struct	A metadata entry in a cloud assembly artifact.
MissingContext	Struct	Represents a missing piece of context.
NestedCloudAssemblyProperties	Struct	Artifact properties for nested cloud assemblies.
PluginContextQuery	Struct	Query input for plugins.
PluginReportJson	Struct	A report from a single validation plugin.
PolicyValidationReportJson	Struct	The top-level structure of the policy validation report file.
PolicyViolationJson	Struct	A single policy violation found by a validation plugin.
PropertyMutationMetadataEntry	Struct	Metadata type of a PropertyMutation.
RequireApproval	Enum	Specify what changes require manual approval.
RuntimeInfo	Struct	Information about the application's runtime components.
SecurityGroupContextQuery	Struct	Query input for looking up a security group.
SSMParameterContextQuery	Struct	Query to SSM Parameter Context Provider.
SuppressedViolationJson	Struct	A violation that was acknowledged/suppressed and excluded from the active violation set.
Tag	Struct	Metadata Entry spec for stack tag.
TestCase	Struct	Represents an integration test case.
TestOptions	Struct	The set of options to control the workflow of the test runner.
TreeArtifactProperties	Struct	Artifact properties for the Construct Tree Artifact.
UnconfiguredBehavesLike	Struct
ViolatingConstructJson	Struct	A construct that violated a policy rule.
VpcContextQuery	Struct	Query input for looking up a VPC.