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.36.0 (2019-06-24)
clusterName
from Services (#2980) (a6e4f6a)onXxx()
methods (#2921) (ea10f0d), closes #2913@aws-cdk/cdk
module was renamed to @aws-cdk/core
, python: aws_cdk.core
, java: the artifact cdk
in groupId software.amazon.awscdk
was renamed to core
@aws-cdk/cdk.Duration
instead of number
, and were renamed to exclude any unit indication.app.run()
has been removed (use app.synth()
).CfnResource.options
property was renamed to CfnResource.cfnOptions
to avoid conflicts with properties introduced by derived classes.CfnXxx.cfnResourceTypeName
is now CFN_RESOURCE_TYPE_NAME
in generated CFN resources.ContextProvider
is no longer designed to be extended. Use ContextProvider.getValue
and ContextProvider.getKey
as utilities.Context.getSsmParameter
has been removed. Use ssm.StringParameter.valueFromLookup
Context.getAvailabilityZones
has been removed. Use stack.availabilityZones
Context.getDefaultAccount
and getDefaultRegion
have been removed an no longer available. Use the environment variables CDK_DEFAULT_ACCOUNT
and CDK_DEFAULT_REGION
instead.StackProps.autoRun
was renamed to StackProps.autoSynth
.CfnElement.refAsString
renamed to ref
of string
type. The IResolvable
version have been removed.IStringValue
renamed to IStringProducer
Include
renamed to CfnInclude
Cfn
prefix was added to the following types: CfnCreationPolicy
, CfnResourceAutoScalingCreationPolicy
, CfnResourceAutoScalingCreationPolicy
, CfnDeletionPolicy
, CfnUpdatePolicy
, CfnAutoScalingRollingUpdate
, CfnAutoScalingReplacingUpdate
, CfnAutoScalingScheduledAction
, CfnCodeDeployLambdaAliasUpdate
, CfnTag
CfnRuleAssertion
, CfnDynamicReferenceProps
deepMerge
is no longer exported.CfnOutputProps.export
was renamed to exportName
.CfnOutput
all properties are now privateStringListCfnOutput
has been removedFn
were made static
, and the Fn
constructor was made private.VpcNetworkProvider
has been removed. Use Vpc.fromLookup
.ec2.MachineImage
will now resolve AMIs from SSM during deployment.ecs.EcsOptimizedAmi
will now resolve AMis from SSM during deployment.hardwareType
was STANDARD
. Now it always defaults to Amazon Linux v2.service.clusterName
has been replaced with .cluster
.requiredTransform
is now REQUIRED_TRANSFORM
in generated code.AwsCustomResource
class was moved to a new module called @aws-cdk/custom-resourcecapabilities
property is now an array to support multiple capabilities.Pipeline.crossRegionScaffoldStacks
has been renamed to crossRegionSupport
, and its type changed from CrossRegionScaffoldStack
to CrossRegionSupport
.CodeCommitAction.pollForSourceChanges
to trigger
and make it an enum.trigger
, and make it an enum.CloudFormationAction
and CloudFormationDeployAction
.HostedZoneProvider
has been removed. Use HostedZone.fromLookup
.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.