@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 to the latest version, run:

npm run update

Any JSON hashes are alpha-sorted to make sure that only actual changes appear in diffs.

Changelog

0.8.2 - 2018-08-15

Features

• @aws-cdk/cdk: Tokens can now be transparently embedded into strings and encoded into JSON without losing their semantics. This makes it possible to treat late-bound (deploy-time) values as if they were regular strings ([@rix0rrr] in #518).
• @aws-cdk/aws-s3: add support for bucket notifications to Lambda, SNS, and SQS targets ([@eladb] in #201, #560, #561, #564)
• @aws-cdk/cdk: non-alphanumeric characters can now be used as construct identifiers ([@eladb] in #556)
• @aws-cdk/aws-iam: add support for maxSessionDuration for Roles ([@eladb] in #545).

Changes

• @aws-cdk/aws-lambda (BREAKING): most classes renamed to be shorter and more in line with official service naming (Lambda renamed to Function or ommitted) ([@eladb] in #550)
• @aws-cdk/aws-codepipeline (BREAKING): move all CodePipeline actions from @aws-cdk/aws-xxx-codepipeline packages into the regular @aws-cdk/aws-xxx service packages ([@skinny85] in #459).
• @aws-cdk/aws-custom-resources (BREAKING): package was removed, and the Custom Resource construct added to the @aws-cdk/aws-cloudformation package ([@rix0rrr] in #513)

Fixes

• @aws-cdk/aws-lambda: Lambdas that are triggered by CloudWatch Events now show up in the console, and can only be triggered the indicated Event Rule. BREAKING for middleware writers (as this introduces an API change), but transparent to regular consumers ([@eladb] in #558)
• @aws-cdk/aws-codecommit: fix a bug where pollForSourceChanges could not be set to false ([@maciejwalkowiak] in #534)
• aws-cdk: don't fail if the ~/.aws/credentials file is missing ([@RomainMuller] in #541)
• @aws-cdk/aws-cloudformation: fix a bug in the CodePipeline actions to correctly support TemplateConfiguration ([@mindstorms6] in #571).
• @aws-cdk/aws-cloudformation: fix a bug in the CodePipeline actions to correctly support ParameterOverrides ([@mindstorms6] in #574).

Known Issues

• cdk init will try to init a git repository and fail if no global user.name and user.email have been configured.