Categorygithub.com/aws/aws-cdk-go/awscdkcloudassemblyschema
package
1.204.0-devpreview
Repository: https://github.com/aws/aws-cdk-go.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
4
Dependents
7
Files
1.7k SLOC

# README

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

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

# Functions

Deprecated.
Load and validates the cloud assembly manifest from file.
Load and validates the asset manifest from file.
Load and validates the integ manifest from file.
Deprecated.
Validates and saves the cloud assembly manifest to file.
Validates and saves the asset manifest to file.
Validates and saves the integ manifest to file.
Fetch the current schema version number.

# Constants

Asset in metadata.
Metadata key used to print ERROR-level messages by the toolkit when an app is syntheized.
Metadata key used to print INFO-level messages by the toolkit when an app is syntheized.
Represents the CloudFormation logical ID of a resource at a certain path.
Represents tags of a stack.
Metadata key used to print WARNING-level messages by the toolkit when an app is syntheized.
Manifest for all assets in the Cloud Assembly.
The artifact is an AWS CloudFormation stack.
The artifact contains the CDK application's construct tree.
Nested Cloud Assembly.
Stub required because of JSII.
AMI provider.
AZ provider.
VPC Endpoint Service AZ Provider.
Route53 Hosted Zone provider.
KMS Key Provider.
Load balancer listener provider.
Load balancer provider.
A plugin provider (the actual plugin name will be in the properties).
Security group provider.
SSM Parameter Provider.
VPC Provider.
Upload the given path as a file.
The given path is a directory, zip it and upload.
HTTP protocol.
HTTPS protocol.
TCP protocol.
TCP and UDP protocol.
TLS protocol.
UDP protocol.
Application load balancer.
Network load balancer.
Prompt for approval for any type of change to the stack.
Only prompt for approval if there are security related changes.
Never ask for approval.

# Structs

Query to AMI context provider.
A manifest for a single artifact within the cloud assembly.
A manifest which describes the cloud assembly.
Definitions for the asset manifest.
Artifact properties for the Asset Manifest.
Query to availability zone context provider.
Artifact properties for CloudFormation stacks.
Destination for assets that need to be uploaded to AWS.
Information needed to access an IAM role created as part of the bootstrap process.
Represents a cdk command i.e.
Options for specific cdk commands that are run as part of the integration test workflow.
Metadata Entry spec for container images.
Default CDK CLI options that apply to all commands.
Represents a cdk deploy command.
Options to use with cdk deploy.
Represents a cdk destroy command.
Options to use with cdk destroy.
A file asset.
Where to publish docker images.
Properties for how to produce a Docker image from a source.
Query to endpoint service context provider.
A file asset.
Metadata Entry spec for files.
Where in S3 a file asset needs to be published.
Describe the source of a file asset.
Commands to run at predefined points during the integration test workflow.
Query to hosted zone context provider.
Definitions for the integration testing manifest.
Query input for looking up a KMS Key.
Query input for looking up a load balancer.
Filters for selecting load balancers.
Query input for looking up a load balancer listener.
Options for the loadManifest operation.
A metadata entry in a cloud assembly artifact.
Represents a missing piece of context.
Artifact properties for nested cloud assemblies.
Query input for plugins.
Information about the application's runtime components.
Query input for looking up a security group.
Query to SSM Parameter Context Provider.
Metadata Entry spec for stack tag.
Represents an integration test case.
The set of options to control the workflow of the test runner.
Artifact properties for the Construct Tree Artifact.
Query input for looking up a VPC.

# Interfaces

Protocol utility class.

# Type aliases

Type of artifact metadata entry.
Type of cloud artifact.
Identifier for the context provider.
Packaging strategy for file assets.
The protocol for connections from clients to the load balancer.
Type of load balancer.
In what scenarios should the CLI ask for approval.