@aws-cdk/cfnspec

What is @aws-cdk/cfnspec?

@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.

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

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);

Other packages similar to @aws-cdk/cfnspec

aws-sdk

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.

cloudformation-js-yaml-schema

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.

cdk

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.

README

AWS CDK CloudFormation Tools

To update the CloudFormation spec, you can run bump-cfnspec.sh from a clean repo, as so -

./scripts/bump-cfnspec.sh

If you wish to only update the CFN spec, make sure to install all dependencies and build the cfnspec module, and then you can just run:

yarn update