Skip to main content

Schema for the protocol between CDK framework and CDK CLI

Project 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 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

See Contribution Guide

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_cdk_cloud_assembly_schema-44.8.0.tar.gz (204.7 kB view details)

Uploaded Source

Built Distribution

aws_cdk_cloud_assembly_schema-44.8.0-py3-none-any.whl (204.3 kB view details)

Uploaded Python 3

File details

Details for the file aws_cdk_cloud_assembly_schema-44.8.0.tar.gz.

File metadata

File hashes

Hashes for aws_cdk_cloud_assembly_schema-44.8.0.tar.gz
Algorithm Hash digest
SHA256 31b88005f070dddc77a7fd10fa4eb1f366c97dd03461ce78db37bbbd07708466
MD5 ef0acc61787e5f747b0b58a546130e29
BLAKE2b-256 2f6fc0387963d93fd2bec646d13ccdfb1885564ad72ae4f04bc70a2faa1661aa

See more details on using hashes here.

File details

Details for the file aws_cdk_cloud_assembly_schema-44.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cdk_cloud_assembly_schema-44.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d76cdb871918794941eab5292e7dc13acd1fced61e00c8aba47db257fae33a2
MD5 4cfe5780758b37ad73b423558fab03db
BLAKE2b-256 e2eafcbb08d95e8ba2a5fe18b7e47e535dca5ab3fe992c05bb22b25851b7e8d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page