Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
@aws-cdk/cfnspec
Advanced tools
@aws-cdk/cfnspec is an npm package that provides CloudFormation resource specifications for AWS CDK. It allows developers to work with AWS CloudFormation resources in a programmatic way, enabling the creation, modification, and validation of AWS infrastructure as code.
Loading CloudFormation Specifications
This feature allows you to load the CloudFormation resource specifications. The `spec` object contains detailed information about all the AWS resources supported by CloudFormation.
const cfnspec = require('@aws-cdk/cfnspec');
const spec = cfnspec.spec;
console.log(spec);
Accessing Resource Types
This feature allows you to access the different resource types available in the CloudFormation specification. The `ResourceTypes` object contains metadata about each resource type.
const cfnspec = require('@aws-cdk/cfnspec');
const resourceTypes = cfnspec.spec.ResourceTypes;
console.log(Object.keys(resourceTypes));
Validating Resource Properties
This feature allows you to validate the properties of a specific resource type. For example, you can retrieve and inspect the properties of an S3 bucket.
const cfnspec = require('@aws-cdk/cfnspec');
const resourceTypes = cfnspec.spec.ResourceTypes;
const s3BucketProps = resourceTypes['AWS::S3::Bucket'].Properties;
console.log(s3BucketProps);
The `aws-sdk` package is the official AWS SDK for JavaScript, providing a comprehensive set of tools for interacting with AWS services. Unlike @aws-cdk/cfnspec, which focuses on CloudFormation specifications, `aws-sdk` allows you to directly interact with AWS services, making API calls to manage resources.
The `cloudformation-js-yaml-schema` package provides a JSON schema for AWS CloudFormation templates. It is useful for validating CloudFormation templates written in YAML or JSON. While it focuses on template validation, @aws-cdk/cfnspec provides a more comprehensive set of tools for working with CloudFormation specifications programmatically.
The `cdk` package is the AWS Cloud Development Kit, which allows you to define cloud infrastructure using a programming language. It provides higher-level abstractions for AWS resources, whereas @aws-cdk/cfnspec provides the raw CloudFormation specifications that can be used to build such abstractions.
To update the CloudFormation spec to the latest version, run:
npm run update
Any JSON hashes are alpha-sorted to make sure that only actual changes appear in diffs.
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 domainName
route53.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.tryGetContext
node.recordReference
is now node.addReference
node.apply
is now node.applyAspect
node.ancestors()
is now node.scopes
node.required
has been removed.node.typename
has been removed.node.addChild
is now privatenode.findReferences()
is now node.references
node.findDependencies()
is now node.dependencies
stack.dependencies()
is now stack.dependencies
CfnElement.stackPath
has been removed.CloudFormationLang
is now internal (use stack.toJsonString()
)@aws-cdk/aws-cloudwatch-actions
package.targets.EcsEc2Task
renamed to targets.EcsTask
endpoint
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-api
addPropertyOverride
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.SecretRotation
rds.ClusterParameterGroup
no longer has setParameter()
and removeParameter()
methods, use the parameters prop directly in the constructor instead.FAQs
The CloudFormation resource specification used by @aws-cdk packages
The npm package @aws-cdk/cfnspec receives a total of 124,572 weekly downloads. As such, @aws-cdk/cfnspec popularity was classified as popular.
We found that @aws-cdk/cfnspec demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 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.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.