Package software.amazon.awscdk.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.
-
ClassDescriptionQuery to AMI context provider.A builder for
AmiContextQuery
An implementation forAmiContextQuery
A manifest for a single artifact within the cloud assembly.A builder forArtifactManifest
An implementation forArtifactManifest
Type of artifact metadata entry.Type of cloud artifact.A manifest which describes the cloud assembly.A builder forAssemblyManifest
An implementation forAssemblyManifest
Definitions for the asset manifest.A builder forAssetManifest
An implementation forAssetManifest
Configuration options for the Asset Manifest.A builder forAssetManifestOptions
An implementation forAssetManifestOptions
Artifact properties for the Asset Manifest.A builder forAssetManifestProperties
An implementation forAssetManifestProperties
Query to availability zone context provider.A builder forAvailabilityZonesContextQuery
An implementation forAvailabilityZonesContextQuery
Artifact properties for CloudFormation stacks.A builder forAwsCloudFormationStackProperties
An implementation forAwsCloudFormationStackProperties
Destination for assets that need to be uploaded to AWS.A builder forAwsDestination
An implementation forAwsDestination
Information needed to access an IAM role created as part of the bootstrap process.A builder forBootstrapRole
An implementation forBootstrapRole
Represents a cdk command i.e.A builder forCdkCommand
An implementation forCdkCommand
Options for specific cdk commands that are run as part of the integration test workflow.A builder forCdkCommands
An implementation forCdkCommands
Options for configuring the Docker cache backend.A builder forContainerImageAssetCacheOption
An implementation forContainerImageAssetCacheOption
Metadata Entry spec for container images.A builder forContainerImageAssetMetadataEntry
An implementation forContainerImageAssetMetadataEntry
Options for context lookup roles.A builder forContextLookupRoleOptions
An implementation forContextLookupRoleOptions
Identifier for the context provider.Default CDK CLI options that apply to all commands.A builder forDefaultCdkOptions
An implementation forDefaultCdkOptions
Represents a cdk deploy command.A builder forDeployCommand
An implementation forDeployCommand
Options to use with cdk deploy.A builder forDeployOptions
An implementation forDeployOptions
Represents a cdk destroy command.A builder forDestroyCommand
An implementation forDestroyCommand
Options to use with cdk destroy.A builder forDestroyOptions
An implementation forDestroyOptions
Options for configuring the Docker cache backend.A builder forDockerCacheOption
An implementation forDockerCacheOption
A file asset.A builder forDockerImageAsset
An implementation forDockerImageAsset
Where to publish docker images.A builder forDockerImageDestination
An implementation forDockerImageDestination
Properties for how to produce a Docker image from a source.A builder forDockerImageSource
An implementation forDockerImageSource
Query to endpoint service context provider.A builder forEndpointServiceAvailabilityZonesContextQuery
An implementation forEndpointServiceAvailabilityZonesContextQuery
A file asset.A builder forFileAsset
An implementation forFileAsset
Metadata Entry spec for files.A builder forFileAssetMetadataEntry
An implementation forFileAssetMetadataEntry
Packaging strategy for file assets.Where in S3 a file asset needs to be published.A builder forFileDestination
An implementation forFileDestination
Describe the source of a file asset.A builder forFileSource
An implementation forFileSource
Commands to run at predefined points during the integration test workflow.A builder forHooks
An implementation forHooks
Query to hosted zone context provider.A builder forHostedZoneContextQuery
An implementation forHostedZoneContextQuery
Definitions for the integration testing manifest.A builder forIntegManifest
An implementation forIntegManifest
Query input for looking up a KMS Key.A builder forKeyContextQuery
An implementation forKeyContextQuery
Query input for looking up a load balancer.A builder forLoadBalancerContextQuery
An implementation forLoadBalancerContextQuery
Filters for selecting load balancers.A builder forLoadBalancerFilter
An implementation forLoadBalancerFilter
Query input for looking up a load balancer listener.A builder forLoadBalancerListenerContextQuery
An implementation forLoadBalancerListenerContextQuery
The protocol for connections from clients to the load balancer.Type of load balancer.Options for the loadManifest operation.A builder forLoadManifestOptions
An implementation forLoadManifestOptions
Protocol utility class.A metadata entry in a cloud assembly artifact.A builder forMetadataEntry
An implementation forMetadataEntry
Represents a missing piece of context.A builder forMissingContext
An implementation forMissingContext
Artifact properties for nested cloud assemblies.A builder forNestedCloudAssemblyProperties
An implementation forNestedCloudAssemblyProperties
Query input for plugins.A builder forPluginContextQuery
An implementation forPluginContextQuery
In what scenarios should the CLI ask for approval.Information about the application's runtime components.A builder forRuntimeInfo
An implementation forRuntimeInfo
Query input for looking up a security group.A builder forSecurityGroupContextQuery
An implementation forSecurityGroupContextQuery
Query to SSM Parameter Context Provider.A builder forSSMParameterContextQuery
An implementation forSSMParameterContextQuery
Metadata Entry spec for stack tag.A builder forTag
An implementation forTag
Represents an integration test case.A builder forTestCase
An implementation forTestCase
The set of options to control the workflow of the test runner.A builder forTestOptions
An implementation forTestOptions
Artifact properties for the Construct Tree Artifact.A builder forTreeArtifactProperties
An implementation forTreeArtifactProperties
Query input for looking up a VPC.A builder forVpcContextQuery
An implementation forVpcContextQuery