@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
0.34.0 (2019-06-07)
aws-cloudwatch-actions (#2688) (e3df21a)recordValue: string prop in route53.TxtRecord changed to values: string[]recordValue prop in route53.CnameRecord renamed to domainNameroute53.AliasRecord has been removed, use route53.ARecord or route53.AaaaRecord with the target prop.EncryptionKeyAlias class was renamed to Alias.
Associated types (such as EncryptionKeyAliasProps) were renamed in the
same way.App.run() was renamed to App.synth() (soft deprecation, it will be removed in the next release).node.stack is now Stack.of(construct) (fixes #2766)node.resolve has been moved to stack.resolve.node.stringifyJson has been moved to stack.stringifyJson.node.validateTree is now ConstructNode.validate(node)node.prepareTree is now ConstructNode.prepare(node)node.getContext is now node.tryGetContextnode.recordReference is now node.addReferencenode.apply is now node.applyAspectnode.ancestors() is now node.scopesnode.required has been removed.node.typename has been removed.node.addChild is now privatenode.findReferences() is now node.referencesnode.findDependencies() is now node.dependenciesstack.dependencies() is now stack.dependenciesCfnElement.stackPath has been removed.CloudFormationLang is now internal (use stack.toJsonString())@aws-cdk/aws-cloudwatch-actions
package.targets.EcsEc2Task renamed to targets.EcsTaskendpoint is now type string (previously any)result in the Pass state is now type map (previously any)@aws-cdk/applet-js, @aws-cdk/aws-autoscaling-api, @aws-cdk/aws-codedeploy-apiaddPropertyOverride should match in capitalization to the CloudFormation schema (normally pascal case). For example, addPropertyOverride('accessControl', 'xxx') should now be addPropertyOverride('AccessControl', 'xxx').rds.RotationSingleUser renamed to rds.SecretRotationrds.ClusterParameterGroup no longer has setParameter() and removeParameter() methods, use the parameters prop directly in the constructor instead.Readme
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.
FAQs
Cloud executable protocol
The npm package @aws-cdk/cx-api receives a total of 616,067 weekly downloads. As such, @aws-cdk/cx-api popularity was classified as popular.
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
Node.js has automated its security release process, doubling the number of releases, and is re-evaluating unsupported experimental features with the Next 10 group to enhance security.
Product
Can you spot malicious malicious packages on the web at a glance? Socket can. Check out our updated Web Extension!
Product
Socket introduces three new customizable default security policies for users to choose from: Low Noise (traditional SCA), Default, and Higher Noise.