@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

0.33.0 (2019-05-30)

IMPORTANT: apps created with the CDK version 0.33.0 and above cannot be used with an older CLI version.

Bug Fixes

core: Fn.cidr should return a list and not a string (#2678) (9d2ea2a), closes #2671
cli: fix ts-node usage on Windows (#2660) (5fe0af5)
cli: make cdk docs open the new API reference (#2633) (6450758)
cli: correctly pass build args to docker build (#2634) (9c58d6f)
core: hide dependencyRoots from public API (#2668) (2ba5ad2), closes #2348
autoscaling: move lifecycle hook targets to their own module (#2628) (b282132), closes #2447
codepipeline: no longer allow providing an index when adding a Stage to a Pipeline. (#2624) (ce39b12)
codepipeline-actions: correctly serialize the userParameters passed to the Lambda invoke Action. (#2537) (ceaf54a)
cx-api: improve compatibility messages for cli <=> app (#2676) (38a9894)
ecs: move high level ECS constructs into aws-ecs-patterns (#2623) (f901313)
logs: move log destinations into 'aws-logs-destinations' (#2655) (01601c2), closes #2444
s3: move notification destinations into their own module (#2659) (185951c), closes #2445

Features

cli: decouple "synth" and "deploy" through cloud assemblies (#2636) (c52bcfc), closes #1893 #2093 #1954 #2310 #2073 #1245 #341 #956 #233 #2016
acm: allow specifying region for validated certificates (#2626) (1a7d4db)
apigateway: support for UsagePlan, ApiKey, UsagePlanKey (#2564) (203f114), closes #723
autoscaling: allow setting spotPrice (#2571) (d640055), closes #2208
cfn: update CloudFormation spec to v3.3.0 (#2669) (0f553ee)
cli: disable noUnusedLocals and noUnusedParameters from typescript templates (#2654) (b061826)
cloudformation: aws-api custom resource (#1850) (9a48b66)
cloudwatch: support all Y-Axis properties (#2406) (8904c3e), closes #2385

BREAKING CHANGES TO EXPERIMENTAL FEATURES

logs: using a Lambda or Kinesis Stream as CloudWatch log subscription destination now requires an integration object from the @aws-cdk/aws-logs-destinations package.
codepipeline-actions: removed the addPutJobResultPolicy property when creating LambdaInvokeAction.
cli: --interactive has been removed
cli: --numbered has been removed
cli: --staging is now a boolean flag that indicates whether assets should be copied to the --output directory or directly referenced (--no-staging is useful for e.g. local debugging with SAM CLI)
assets: Assets (e.g. Lambda code assets) are now referenced relative to the output directory.
assert: SynthUtils.templateForStackName has been removed (use SynthUtils.synthesize(stack).template).
cx-api: cxapi.SynthesizedStack renamed to cxapi.CloudFormationStackArtifact with multiple API changes.
core: cdk.App.run() now returns a cxapi.CloudAssembly instead of cdk.ISynthesisSession.
s3: using a Topic, Queue or Lambda as bucket notification destination now requires an integration object from the @aws-cdk/aws-s3-notifications package.
autoscaling: using a Topic, Queue or Lambda as Lifecycle Hook Target now requires an integration object from the @aws-cdk/aws-autoscaling-hooktargets package.
codepipeline: the property atIndex has been removed from the StagePlacement interface.
aws-ecs: These changes move all L3 and higher constructs out of the aws-ecs module into the aws-ecs-patterns module. The following constructs have been moved into the aws-ecs-patterns module: EcsQueueWorkerService, FargateQueueWorkerService, LoadBalancedEcsService, LoadBalancedFargateService and LoadBalancedFargateServiceApplets.
cloudwatch: rename leftAxisRange => leftYAxis, rightAxisRange => rightYAxis, rename YAxisRange => YAxisProps.

Readme

Source

Cloud Executable protocol

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?

Package last updated on 30 May 2019

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