@aws-cdk/cloud-assembly-schema
Advanced tools
Package description
@aws-cdk/cloud-assembly-schema is a package that defines the schema for AWS Cloud Development Kit (CDK) cloud assemblies. It provides a set of TypeScript interfaces and JSON schemas that describe the structure of the cloud assembly, which is the output of the CDK synthesis process. This package is essential for tools and libraries that need to interact with or manipulate CDK cloud assemblies.
Cloud Assembly Schema Definition
Defines the schema for a cloud assembly, including the version and artifacts. This schema is used to validate the structure of a cloud assembly JSON file.
{"type":"object","properties":{"version":{"type":"string"},"artifacts":{"type":"object","additionalProperties":{"$ref":"#/definitions/Artifact"}}},"required":["version","artifacts"],"definitions":{"Artifact":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object"}},"required":["type"]}}}Artifact Type Definitions
Defines the schema for different types of artifacts, such as CloudFormation stacks and CDK assets. This schema is used to validate the structure of artifact definitions within a cloud assembly.
{"type":"object","properties":{"type":{"type":"string","enum":["aws:cloudformation:stack","aws:cdk:asset"]},"properties":{"type":"object","properties":{"templateFile":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}},"required":["templateFile"]}},"required":["type","properties"]}The aws-cdk-lib package is the main library for the AWS Cloud Development Kit (CDK). It provides constructs for defining AWS infrastructure in code. While @aws-cdk/cloud-assembly-schema focuses on the schema of the cloud assembly, aws-cdk-lib provides the constructs and classes needed to define and synthesize the infrastructure itself.
cdk8s is a software development framework for defining Kubernetes applications and resources using familiar programming languages. Similar to how @aws-cdk/cloud-assembly-schema defines the schema for AWS CDK cloud assemblies, cdk8s provides schemas and constructs for defining Kubernetes manifests.
Changelog
1.135.0 (2021-12-10)
authorizerName
in HttpJwtAuthorizerProps has changed.HttpJwtAuthorizer now takes the
construct id and the target jwt issuer as part of its constructor.HttpLambdaAuthorizer now takes
the construct id and the target lambda function handler as part of
its constructor.authorizerName in HttpUserPoolAuthorizerProps has changed.HttpIntegration and WebSocketIntegration
classes require an "id" parameter to be provided during its initialization.LambdaWebSocketIntegration is now
renamed to WebSocketLambdaIntegration. The new class accepts the
handler to the target lambda function directly in its constructor.HttpProxyIntegration and
HttpProxyIntegrationProps are now renamed to HttpUrlIntegration
and HttpUrlIntegrationProps respectively. The new class accepts the
target url directly in its constructor.LambdaProxyIntegration and
LambdaProxyIntegrationProps are now renamed to
HttpLambdaIntegration and HttpLambdaIntegrationProps respectively.
The new class accepts the lambda function handler directly in its
constructor.HttpAlbIntegration now accepts the
ELB listener directly in its constructor.HttpNlbIntegration now accepts the
ELB listener directly in its constructor.HttpServiceDiscoveryIntegration now
accepts the service discovery Service directly in its constructor.UserPoolAuthorizerProps is now
renamed to HttpUserPoolAuthorizerProps.IHttpRouteIntegration is replaced by
the abstract class HttpRouteIntegration.IWebSocketRouteIntegration is now
replaced by the abstract class WebSocketRouteIntegration.HttpApi instances
(or WebSocketApi instances). This is now disallowed, and separate
instances must be created for each instance of HttpApi or
WebSocketApi.fromGroupName() for IAM groups (#17243) (29b379c)stringLike() (#17692) (37596e6)Stage (#17730) (f17f29e), closes #17643waitForReplicationToFinish fails deployment (#17842) (36b8fdb), closes #16983nodeModules (#17851) (5737c33), closes #17830nodeModules fails with paths containing spaces (#17632) (986f291), closes #17631Readme
This module is part of the AWS Cloud Development Kit project.
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.
This module contains the typescript structs that comprise the manifest.json file, as well as the
generated json-schema.
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.
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.
FAQs
Cloud Assembly Schema
The npm package @aws-cdk/cloud-assembly-schema receives a total of 509,457 weekly downloads. As such, @aws-cdk/cloud-assembly-schema popularity was classified as popular.
We found that @aws-cdk/cloud-assembly-schema demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno's Standard Library has stabilized after four years of development, offering developers a collection of well-maintained tools compatible with Deno, Node.js, Cloudflare Workers, and browsers with bundlers.
Security News
Trivial packages, while convenient, can introduce significant risks such as dependency bloat, security vulnerabilities, and performance issues in modern software projects.
Security News
PyPI has drastically improved its malware response times, resolving 90% of issues in under 24 hours and removing 900 projects since March 2024.