@aws-sdk/client-cloudformation

What is @aws-sdk/client-cloudformation?

The @aws-sdk/client-cloudformation npm package is a client library for AWS CloudFormation service. It allows developers to interact with the AWS CloudFormation service programmatically, enabling them to create, manage, and deploy AWS CloudFormation stacks and resources directly from their JavaScript or TypeScript applications.

What are @aws-sdk/client-cloudformation's main functionalities?

Managing Stacks

This feature allows you to manage AWS CloudFormation stacks, including creating, updating, and deleting stacks.

const { CloudFormationClient, CreateStackCommand } = require('@aws-sdk/client-cloudformation');

const client = new CloudFormationClient({ region: 'us-west-2' });
const createStackParams = {
  StackName: 'MyStack',
  TemplateBody: 'JSON or YAML template',
};

const command = new CreateStackCommand(createStackParams);
client.send(command).then((data) => {
  console.log('Stack creation initiated:', data);
}).catch((error) => {
  console.error('Error creating stack:', error);
});

Describing Stack Resources

This feature allows you to retrieve information about the resources within a specific stack.

const { CloudFormationClient, DescribeStackResourcesCommand } = require('@aws-sdk/client-cloudformation');

const client = new CloudFormationClient({ region: 'us-west-2' });
const describeStackResourcesParams = {
  StackName: 'MyStack'
};

const command = new DescribeStackResourcesCommand(describeStackResourcesParams);
client.send(command).then((data) => {
  console.log('Stack resources:', data);
}).catch((error) => {
  console.error('Error describing stack resources:', error);
});

Listing Stacks

This feature allows you to list all stacks and their statuses in your AWS account.

const { CloudFormationClient, ListStacksCommand } = require('@aws-sdk/client-cloudformation');

const client = new CloudFormationClient({ region: 'us-west-2' });
const command = new ListStacksCommand({});
client.send(command).then((data) => {
  console.log('List of stacks:', data);
}).catch((error) => {
  console.error('Error listing stacks:', error);
});

Other packages similar to @aws-sdk/client-cloudformation

aws-sdk

The 'aws-sdk' package is the predecessor of the '@aws-sdk/client-cloudformation' and provides a comprehensive AWS SDK for JavaScript. It supports CloudFormation operations but is not modular, meaning it includes the entire AWS SDK rather than just the CloudFormation service.

serverless

The 'serverless' package is a framework for building serverless applications using AWS Lambda and other cloud providers. It includes functionality for managing infrastructure as code, similar to CloudFormation, but it is more opinionated and provides a higher-level abstraction for deploying serverless applications.

pulumi

The 'pulumi' package is a modern infrastructure as code SDK that allows you to define cloud resources using general-purpose programming languages. It is similar to CloudFormation in that it manages cloud resources but offers a different approach by using familiar programming languages and real code to define infrastructure.

README

@aws-sdk/client-cloudformation

For SDK usage, please step to SDK reademe.