# Cloud Assembly Schema
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
## Cloud Assembly
The *Cloud Assembly* is the output of the synthesis operation. It is produced as part of the
[`cdk synth`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-synthesize)
command, or the [`app.synth()`](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/lib/app.ts#L135) 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*](./schema/cloud-assembly.schema.json).
## 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](./schema/cloud-assembly.schema.json) 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](https://www.npmjs.com/package/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](./CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/cdklabs/cloud-assembly-schema",
"name": "aws-cdk.cloud-assembly-schema",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2e/2f/9c1ce62724a5c66b0f215c582465b3b0916f84c1038b9f190fab4a8f25b7/aws_cdk_cloud_assembly_schema-39.0.12.tar.gz",
"platform": null,
"description": "# Cloud Assembly Schema\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Cloud Assembly\n\nThe *Cloud Assembly* is the output of the synthesis operation. It is produced as part of the\n[`cdk synth`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-synthesize)\ncommand, or the [`app.synth()`](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/lib/app.ts#L135) method invocation.\n\nIts essentially a set of files and directories, one of which is the `manifest.json` file. It defines the set of instructions that are\nneeded in order to deploy the assembly directory.\n\n> For example, when `cdk deploy` is executed, the CLI reads this file and performs its instructions:\n>\n> * Build container images.\n> * Upload assets.\n> * Deploy CloudFormation templates.\n\nTherefore, the assembly is how the CDK class library and CDK CLI (or any other consumer) communicate. To ensure compatibility\nbetween the assembly and its consumers, we treat the manifest file as a well defined, versioned schema.\n\n## Schema\n\nThis module contains the typescript structs that comprise the `manifest.json` file, as well as the\ngenerated [*json-schema*](./schema/cloud-assembly.schema.json).\n\n## Versioning\n\nThe schema version is specified my the major version of the package release. It follows semantic versioning, but with a small twist.\n\nWhen we add instructions to the assembly, they are reflected in the manifest file and the *json-schema* accordingly.\nEvery such instruction, is crucial for ensuring the correct deployment behavior. This means that to properly deploy a cloud assembly,\nconsumers must be aware of every such instruction modification.\n\nFor this reason, every change to the schema, even though it might not strictly break validation of the *json-schema* format,\nis considered `major` version bump. All changes that do not impact the schema are considered a `minor` version bump.\n\n## How to consume\n\nIf you'd like to consume the [schema file](./schema/cloud-assembly.schema.json) in order to do validations on `manifest.json` files,\nsimply download it from this repo and run it against standard *json-schema* validators, such as [jsonschema](https://www.npmjs.com/package/jsonschema).\n\nConsumers must take into account the `major` version of the schema they are consuming. They should reject cloud assemblies\nwith a `major` version that is higher than what they expect. While schema validation might pass on such assemblies, the deployment integrity\ncannot be guaranteed because some instructions will be ignored.\n\n> For example, if your consumer was built when the schema version was 2.0.0, you should reject deploying cloud assemblies with a\n> manifest version of 3.0.0.\n\n## Contributing\n\nSee [Contribution Guide](./CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Cloud Assembly Schema",
"version": "39.0.12",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cloud-assembly-schema",
"Source": "https://github.com/cdklabs/cloud-assembly-schema.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23768142a440be2abc6e16d92594d010d0ab3b549fdc80bfeba32ae1d7ac47e0",
"md5": "9e447259c5975005998d9365a76b079d",
"sha256": "fd5d862f89d49e92dbd66e4a43e5125041de3db14fdec505644f030c95b96e16"
},
"downloads": -1,
"filename": "aws_cdk.cloud_assembly_schema-39.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e447259c5975005998d9365a76b079d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 182994,
"upload_time": "2024-11-24T00:29:43",
"upload_time_iso_8601": "2024-11-24T00:29:43.689688Z",
"url": "https://files.pythonhosted.org/packages/23/76/8142a440be2abc6e16d92594d010d0ab3b549fdc80bfeba32ae1d7ac47e0/aws_cdk.cloud_assembly_schema-39.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e2f9c1ce62724a5c66b0f215c582465b3b0916f84c1038b9f190fab4a8f25b7",
"md5": "0121becf922e50c3215a8a93905ac5ab",
"sha256": "4155e3e4d3a2d986f79a39a92ff9181c624e11cc8203f3e43d2bb4b9ec41f040"
},
"downloads": -1,
"filename": "aws_cdk_cloud_assembly_schema-39.0.12.tar.gz",
"has_sig": false,
"md5_digest": "0121becf922e50c3215a8a93905ac5ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 184360,
"upload_time": "2024-11-24T00:29:45",
"upload_time_iso_8601": "2024-11-24T00:29:45.497919Z",
"url": "https://files.pythonhosted.org/packages/2e/2f/9c1ce62724a5c66b0f215c582465b3b0916f84c1038b9f190fab4a8f25b7/aws_cdk_cloud_assembly_schema-39.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 00:29:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cloud-assembly-schema",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.cloud-assembly-schema"
}
JSON
