@aws-cdk/cx-api is a part of the AWS Cloud Development Kit (CDK) that provides a set of APIs for interacting with the Cloud Assembly, which is the output of the CDK synthesis process. It allows developers to programmatically access and manipulate the synthesized cloud infrastructure stacks, assets, and metadata.

What are @aws-cdk/cx-api's main functionalities?

Accessing Cloud Assembly

This feature allows you to load and interact with a Cloud Assembly, which is the output directory of a CDK app synthesis. The code sample demonstrates how to load a Cloud Assembly from a specified path and log the stacks it contains.

const cxapi = require('@aws-cdk/cx-api');
const assembly = new cxapi.CloudAssembly('/path/to/cloud-assembly');
console.log(assembly.stacks);

Reading Stack Metadata

This feature allows you to read metadata from a specific stack within the Cloud Assembly. The code sample shows how to get a stack by its name and log its metadata.

const cxapi = require('@aws-cdk/cx-api');
const assembly = new cxapi.CloudAssembly('/path/to/cloud-assembly');
const stack = assembly.getStackByName('MyStack');
console.log(stack.metadata);

Listing Assets

This feature allows you to list all the assets included in the Cloud Assembly. The code sample demonstrates how to log all the assets in the Cloud Assembly.

const cxapi = require('@aws-cdk/cx-api');
const assembly = new cxapi.CloudAssembly('/path/to/cloud-assembly');
console.log(assembly.assets);

Other packages similar to @aws-cdk/cx-api

Changelog

Source

1.23.0 (2020-02-07)

Features

appsync: add support for mapping DynamoDB queries (#5940) (2240e97), closes #5861
aws-codebuild: allow github sourceversion branch (#5890) (155b80e), closes #5777
cloudformation: update Resource Specification to v10.4.0 (#5982) (178ca5e)
ecs: add support for enabling container insights (#5601) (6236634)
ecs: ContainerImage.fromDockerImageAsset (b94577a), closes #5791 #5983
ecs: ContainerImage.fromDockerImageAsset (#6093) (38e9865), closes #5791 #5983
ecs: Firelens log driver support (#5457) (4acf0f7)
lambda: avail function log group in the CDK (#5878) (fd54a17), closes #3838
lambda: higher level construct for Node.js (#5532) (02d0e2a)

Bug Fixes

assets: add exclude glob patterns to calculating fingerprint for staging (#6085) (d9a043b), closes #5238
aws-s3-deployment: fix server side encryption parameters (#6006) (c7197c0), closes #6002
cli: colored text is unreadable when using light themes (#5250) (b4573ef)
cli: parse equals sign in context values (#5773) (667443c), closes #5738
codepipeline: manual approval action doesn't have configuration without a topic (#6106) (a63cbf8), closes #6100
cognito: standard attr timezone unexpectedly creates custom attr (#5973) (acf3ffc)
ec2: add MachineImage factory, document instance replacement (#6065) (435d810), closes #5675 #6025
ec2: private DNS for custom endpoints has incorrect default (d681d96)
ecr-assets: docker images are not built if .dockerignore includes an entry that ignores the dockerfile. (#6007) (e7ef5e5)
ecs: fix splunk-sourcetype (#6128) (6456a7c)
ecs-patterns: queue service grant permission automatically (#6110) (0d0794e)
ecs-patterns: remove duplicated schedule property for scheduled task pattern (#6101) (15b6aa7)
eks: missing VPC permissions for fargate profiles (#6074) (0a586fc)
glue: Make Glue Database locationUri optional. (#5784) (a065169), closes #5268 #5268 #5268 #5268
iam: policies added to immutably imported role (#6090) (f1f5319), closes #5569 #5943
init-templates: JavaScript, TypeScript, and Python init templates are broken in 1.21.0 (#5989) (505c91e), closes #5986
route53: CaaAmazonRecord ignores recordName (#6027) (16f9721), closes #5764
route53: correct import example in README.md (#5946) (ed71931)
s3-deployment: passing any system metadata causes lambda to fail on "Unknown options:" when invoking aws cli. (#6086) (b30add8)

Readme

Source

Cloud Executable protocol

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.

This module is part of the AWS Cloud Development Kit project.

Keywords

FAQs

What is @aws-cdk/cx-api?

Is @aws-cdk/cx-api popular?

Is @aws-cdk/cx-api well maintained?

Last updated on 07 Feb 2020

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.

Install