@aws-cdk/cx-api
Advanced tools
Package description
@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.
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);The AWS SDK for JavaScript provides a comprehensive set of APIs for interacting with AWS services. While it does not specifically focus on the Cloud Assembly or CDK synthesis output, it allows for a wide range of AWS service interactions, including managing infrastructure, which can complement the use of @aws-cdk/cx-api.
The Serverless Framework is a popular open-source framework for building and deploying serverless applications. It provides functionalities for defining and deploying cloud infrastructure, similar to the CDK, but focuses on serverless architectures. It does not provide direct access to a Cloud Assembly like @aws-cdk/cx-api.
Terraform by HashiCorp is an open-source infrastructure as code software tool that provides a consistent CLI workflow to manage hundreds of cloud services. It allows for the definition, preview, and deployment of cloud infrastructure. While it serves a similar purpose to the CDK, it does not have a direct equivalent to the Cloud Assembly or @aws-cdk/cx-api.
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
FAQs
Cloud executable protocol
We found that @aws-cdk/cx-api 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.
