This package has been deprecated

Author message:

The package @aws-sdk/client-cloudformation-node has been renamed to @aws-sdk/client-cloudformation. Please install the renamed package.

@aws-sdk/client-cloudformation-node

Description

AWS CloudFormation

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-cloudformation-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(CloudFormationClient) and the commands you need, for example CancelUpdateStackCommand:

//JavaScript
const {
  CloudFormationClient
} = require("@aws-sdk/client-cloudformation-node/CloudFormationClient");
const {
  CancelUpdateStackCommand
} = require("@aws-sdk/client-cloudformation-node/commands/CancelUpdateStackCommand");

//TypeScript
import { CloudFormationClient } from "@aws-sdk/client-cloudformation-node/CloudFormationClient";
import { CancelUpdateStackCommand } from "@aws-sdk/client-cloudformation-node/commands/CancelUpdateStackCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

const cloudFormation = new CloudFormationClient({region: 'region'});
//clients can be shared by different commands
const params = {
  StackName: /**a string value*/,
};
const cancelUpdateStackCommand = new CancelUpdateStackCommand(params);
cloudFormation.send(cancelUpdateStackCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await cloudFormation.send(cancelUpdateStackCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
cloudFormation.send(cancelUpdateStackCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-cloudformation-node/CloudFormation";
const cloudFormation = new AWS.CloudFormation({ region: "region" });
cloudFormation.cancelUpdateStack(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await cloudFormation.send(cancelUpdateStackCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cloudformation-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.