Class: AWS.CloudFormation

Inherits:
AWS.Service show all
Identifier:
cloudformation
API Version:
2010-05-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using CloudFormation

var cloudformation = new AWS.CloudFormation();
cloudformation.cancelUpdateStack(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CloudFormation object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudformation = new AWS.CloudFormation({apiVersion: '2010-05-15'});

You can also set the API version globally in AWS.config.apiVersions using the cloudformation service identifier:

AWS.config.apiVersions = {
  cloudformation: '2010-05-15',
  // other service API versions
};

var cloudformation = new AWS.CloudFormation();

Version:

  • 2010-05-15

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

stackExists, stackCreateComplete, stackDeleteComplete, stackUpdateComplete, changeSetCreateComplete

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CloudFormation(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CloudFormation object

var cloudformation = new AWS.CloudFormation({apiVersion: '2010-05-15'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CloudFormation.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CloudFormation.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CloudFormation.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelUpdateStack(params = {}, callback) ⇒ AWS.Request

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

Note: You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Service Reference:

Examples:

Calling the cancelUpdateStack operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
cloudformation.cancelUpdateStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack.

    • ClientRequestToken — (String)

      A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

continueUpdateRollback(params = {}, callback) ⇒ AWS.Request

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

Service Reference:

Examples:

Calling the continueUpdateRollback operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  ResourcesToSkip: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE'
};
cloudformation.continueUpdateRollback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique ID of the stack that you want to continue rolling back.

      Note: Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).
    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

      If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

    • ResourcesToSkip — (Array<String>)

      A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

      Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

      Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

      To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID. If the ResourceLogicalID is a stack resource (Type: AWS::CloudFormation::Stack), it must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

    • ClientRequestToken — (String)

      A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createChangeSet(params = {}, callback) ⇒ AWS.Request

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.

Service Reference:

Examples:

Calling the createChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM,
    /* more items */
  ],
  ChangeSetType: CREATE | UPDATE,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE',
  UsePreviousTemplate: true || false
};
cloudformation.createChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

    • TemplateBody — (String)

      A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

      Conditional: You must specify only TemplateBody or TemplateURL.

    • TemplateURL — (String)

      The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

      Conditional: You must specify only TemplateBody or TemplateURL.

    • UsePreviousTemplate — (Boolean)

      Whether to reuse the template that is associated with the stack to create the change set.

    • Parameters — (Array<map>)

      A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

      • ParameterKey — (String)

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The value associated with the parameter.

      • UsePreviousValue — (Boolean)

        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

    • Capabilities — (Array<String>)

      A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

      The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

    • ResourceTypes — (Array<String>)

      The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

      If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

      If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

    • NotificationARNs — (Array<String>)

      The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

    • Tags — (Array<map>)

      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.

      • Key — (String)

        Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

      • Value — (String)

        Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

    • ChangeSetName — (String)

      The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

      A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

    • ClientToken — (String)

      A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.

    • Description — (String)

      A description to help you identify this change set.

    • ChangeSetType — (String)

      The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE.

      If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

      By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

      Possible values include:
      • "CREATE"
      • "UPDATE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The Amazon Resource Name (ARN) of the change set.

      • StackId — (String)

        The unique ID of the stack.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createStack(params = {}, callback) ⇒ AWS.Request

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.

Service Reference:

Examples:

Calling the createStack operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM,
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  DisableRollback: true || false,
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  OnFailure: DO_NOTHING | ROLLBACK | DELETE,
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  StackPolicyBody: 'STRING_VALUE',
  StackPolicyURL: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE',
  TimeoutInMinutes: 0
};
cloudformation.createStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

      Note: A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
    • TemplateBody — (String)

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    • TemplateURL — (String)

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    • Parameters — (Array<map>)

      A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

      • ParameterKey — (String)

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The value associated with the parameter.

      • UsePreviousValue — (Boolean)

        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

    • DisableRollback — (Boolean)

      Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

      Default: false

    • TimeoutInMinutes — (Integer)

      The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

    • NotificationARNs — (Array<String>)

      The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

    • Capabilities — (Array<String>)

      A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

      The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

    • ResourceTypes — (Array<String>)

      The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).

      If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

      If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

    • OnFailure — (String)

      Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

      Default: ROLLBACK

      Possible values include:
      • "DO_NOTHING"
      • "ROLLBACK"
      • "DELETE"
    • StackPolicyBody — (String)

      Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    • StackPolicyURL — (String)

      Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    • Tags — (Array<map>)

      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.

      • Key — (String)

        Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

      • Value — (String)

        Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

    • ClientRequestToken — (String)

      A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackId — (String)

        Unique identifier of the stack.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteChangeSet(params = {}, callback) ⇒ AWS.Request

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, AWS CloudFormation successfully deleted the change set.

Service Reference:

Examples:

Calling the deleteChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE'
};
cloudformation.deleteChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ChangeSetName — (String)

      The name or Amazon Resource Name (ARN) of the change set that you want to delete.

    • StackName — (String)

      If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteStack(params = {}, callback) ⇒ AWS.Request

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.

Service Reference:

Examples:

Calling the deleteStack operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  RetainResources: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE'
};
cloudformation.deleteStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack.

    • RetainResources — (Array<String>)

      For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.

      Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.

      If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

    • ClientRequestToken — (String)

      A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccountLimits(params = {}, callback) ⇒ AWS.Request

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.

Service Reference:

Examples:

Calling the describeAccountLimits operation

var params = {
  NextToken: 'STRING_VALUE'
};
cloudformation.describeAccountLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      A string that identifies the next page of limits that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountLimits — (Array<map>)

        An account limit structure that contain a list of AWS CloudFormation account limits and their values.

        • Name — (String)

          The name of the account limit. Currently, the only account limit is StackLimit.

        • Value — (Integer)

          The value that is associated with the account limit name.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeChangeSet(params = {}, callback) ⇒ AWS.Request

Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.

Service Reference:

Examples:

Calling the describeChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  StackName: 'STRING_VALUE'
};
cloudformation.describeChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ChangeSetName — (String)

      The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    • StackName — (String)

      If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

    • NextToken — (String)

      A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeSetName — (String)

        The name of the change set.

      • ChangeSetId — (String)

        The ARN of the change set.

      • StackId — (String)

        The ARN of the stack that is associated with the change set.

      • StackName — (String)

        The name of the stack that is associated with the change set.

      • Description — (String)

        Information about the change set.

      • Parameters — (Array<map>)

        A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

        • ParameterKey — (String)

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

        • ParameterValue — (String)

          The value associated with the parameter.

        • UsePreviousValue — (Boolean)

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

      • CreationTime — (Date)

        The start time when the change set was created, in UTC.

      • ExecutionStatus — (String)

        If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

        Possible values include:
        • "UNAVAILABLE"
        • "AVAILABLE"
        • "EXECUTE_IN_PROGRESS"
        • "EXECUTE_COMPLETE"
        • "EXECUTE_FAILED"
        • "OBSOLETE"
      • Status — (String)

        The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

        Possible values include:
        • "CREATE_PENDING"
        • "CREATE_IN_PROGRESS"
        • "CREATE_COMPLETE"
        • "DELETE_COMPLETE"
        • "FAILED"
      • StatusReason — (String)

        A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.

      • NotificationARNs — (Array<String>)

        The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

      • Capabilities — (Array<String>)

        If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      • Tags — (Array<map>)

        If you execute the change set, the tags that will be associated with the stack.

        • Key — (String)

          Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

        • Value — (String)

          Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • Changes — (Array<map>)

        A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

        • Type — (String)

          The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.

          Possible values include:
          • "Resource"
        • ResourceChange — (map)

          A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.

          • Action — (String)

            The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

            Possible values include:
            • "Add"
            • "Modify"
            • "Remove"
          • LogicalResourceId — (String)

            The resource's logical ID, which is defined in the stack's template.

          • PhysicalResourceId — (String)

            The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

          • ResourceType — (String)

            The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

          • Replacement — (String)

            For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

            If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

            Possible values include:
            • "True"
            • "False"
            • "Conditional"
          • Scope — (Array<String>)

            For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

          • Details — (Array<map>)

            For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

            • Target — (map)

              A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.

              • Attribute — (String)

                Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

                Possible values include:
                • "Properties"
                • "Metadata"
                • "CreationPolicy"
                • "UpdatePolicy"
                • "DeletionPolicy"
                • "Tags"
              • Name — (String)

                If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

              • RequiresRecreation — (String)

                If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.

                Possible values include:
                • "Never"
                • "Conditionally"
                • "Always"
            • Evaluation — (String)

              Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

              For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

              For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

              Possible values include:
              • "Static"
              • "Dynamic"
            • ChangeSource — (String)

              The group to which the CausingEntity value belongs. There are five entity groups:

              • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.

              • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.

              • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.

              • DirectModification entities are changes that are made directly to the template.

              • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.

              Possible values include:
              • "ResourceReference"
              • "ParameterReference"
              • "ResourceAttribute"
              • "DirectModification"
              • "Automatic"
            • CausingEntity — (String)

              The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

              If the ChangeSource value is DirectModification, no value is given for CausingEntity.

      • NextToken — (String)

        If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeStackEvents(params = {}, callback) ⇒ AWS.Request

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

Note: You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

Service Reference:

Examples:

Calling the describeStackEvents operation

var params = {
  NextToken: 'STRING_VALUE',
  StackName: 'STRING_VALUE'
};
cloudformation.describeStackEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of events that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackEvents — (Array<map>)

        A list of StackEvents structures.

        • StackIdrequired — (String)

          The unique ID name of the instance of the stack.

        • EventIdrequired — (String)

          The unique ID of this event.

        • StackNamerequired — (String)

          The name associated with a stack.

        • LogicalResourceId — (String)

          The logical name of the resource specified in the template.

        • PhysicalResourceId — (String)

          The name or unique identifier associated with the physical instance of the resource.

        • ResourceType — (String)

          Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

        • Timestamprequired — (Date)

          Time the status was updated.

        • ResourceStatus — (String)

          Current status of the resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "DELETE_SKIPPED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

        • ResourceProperties — (String)

          BLOB of the properties used to create the resource.

        • ClientRequestToken — (String)

          The token passed to the operation that generated this event.

          For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeStackResource(params = {}, callback) ⇒ AWS.Request

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

Service Reference:

Examples:

Calling the describeStackResource operation

var params = {
  LogicalResourceId: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE' /* required */
};
cloudformation.describeStackResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • LogicalResourceId — (String)

      The logical name of the resource as specified in the template.

      Default: There is no default value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackResourceDetail — (map)

        A StackResourceDetail structure containing the description of the specified resource in the specified stack.

        • StackName — (String)

          The name associated with the stack.

        • StackId — (String)

          Unique identifier of the stack.

        • LogicalResourceIdrequired — (String)

          The logical name of the resource specified in the template.

        • PhysicalResourceId — (String)

          The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

        • ResourceTyperequired — (String)

          Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

        • LastUpdatedTimestamprequired — (Date)

          Time the status was updated.

        • ResourceStatusrequired — (String)

          Current status of the resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "DELETE_SKIPPED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

        • Description — (String)

          User defined description associated with the resource.

        • Metadata — (String)

          The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeStackResources(params = {}, callback) ⇒ AWS.Request

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Note: Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

Note: A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Service Reference:

Examples:

Calling the describeStackResources operation

var params = {
  LogicalResourceId: 'STRING_VALUE',
  PhysicalResourceId: 'STRING_VALUE',
  StackName: 'STRING_VALUE'
};
cloudformation.describeStackResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

      Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

    • LogicalResourceId — (String)

      The logical name of the resource as specified in the template.

      Default: There is no default value.

    • PhysicalResourceId — (String)

      The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

      For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

      Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

      Default: There is no default value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackResources — (Array<map>)

        A list of StackResource structures.

        • StackName — (String)

          The name associated with the stack.

        • StackId — (String)

          Unique identifier of the stack.

        • LogicalResourceIdrequired — (String)

          The logical name of the resource specified in the template.

        • PhysicalResourceId — (String)

          The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

        • ResourceTyperequired — (String)

          Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

        • Timestamprequired — (Date)

          Time the status was updated.

        • ResourceStatusrequired — (String)

          Current status of the resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "DELETE_SKIPPED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

        • Description — (String)

          User defined description associated with the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeStacks(params = {}, callback) ⇒ AWS.Request

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Note: If the stack does not exist, an AmazonCloudFormationException is returned.

Service Reference:

Examples:

Calling the describeStacks operation

var params = {
  NextToken: 'STRING_VALUE',
  StackName: 'STRING_VALUE'
};
cloudformation.describeStacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        A list of stack structures.

        • StackId — (String)

          Unique identifier of the stack.

        • StackNamerequired — (String)

          The name associated with the stack.

        • ChangeSetId — (String)

          The unique ID of the change set.

        • Description — (String)

          A user-defined description associated with the stack.

        • Parameters — (Array<map>)

          A list of Parameter structures.

          • ParameterKey — (String)

            The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The value associated with the parameter.

          • UsePreviousValue — (Boolean)

            During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

        • CreationTimerequired — (Date)

          The time at which the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • StackStatusrequired — (String)

          Current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/failure message associated with the stack status.

        • DisableRollback — (Boolean)

          Boolean to enable or disable rollback on stack creation failures:

          • true: disable rollback

          • false: enable rollback

        • NotificationARNs — (Array<String>)

          SNS topic ARNs to which stack related events are published.

        • TimeoutInMinutes — (Integer)

          The amount of time within which stack creation should complete.

        • Capabilities — (Array<String>)

          The capabilities allowed in the stack.

        • Outputs — (Array<map>)

          A list of output structures.

          • OutputKey — (String)

            The key associated with the output.

          • OutputValue — (String)

            The value associated with the output.

          • Description — (String)

            User defined description associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

        • Tags — (Array<map>)

          A list of Tags that specify information about the stack.

          • Key — (String)

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

          • Value — (String)

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

estimateTemplateCost(params = {}, callback) ⇒ AWS.Request

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Service Reference:

Examples:

Calling the estimateTemplateCost operation

var params = {
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE'
};
cloudformation.estimateTemplateCost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TemplateBody — (String)

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

      Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

    • TemplateURL — (String)

      Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    • Parameters — (Array<map>)

      A list of Parameter structures that specify input parameters.

      • ParameterKey — (String)

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The value associated with the parameter.

      • UsePreviousValue — (Boolean)

        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Url — (String)

        An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

executeChangeSet(params = {}, callback) ⇒ AWS.Request

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

Service Reference:

Examples:

Calling the executeChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  StackName: 'STRING_VALUE'
};
cloudformation.executeChangeSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ChangeSetName — (String)

      The name or ARN of the change set that you want use to update the specified stack.

    • StackName — (String)

      If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

    • ClientRequestToken — (String)

      A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getStackPolicy(params = {}, callback) ⇒ AWS.Request

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Service Reference:

Examples:

Calling the getStackPolicy operation

var params = {
  StackName: 'STRING_VALUE' /* required */
};
cloudformation.getStackPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or unique stack ID that is associated with the stack whose policy you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackPolicyBody — (String)

        Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTemplate(params = {}, callback) ⇒ AWS.Request

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

Note: If the template does not exist, a ValidationError is returned.

Service Reference:

Examples:

Calling the getTemplate operation

var params = {
  ChangeSetName: 'STRING_VALUE',
  StackName: 'STRING_VALUE',
  TemplateStage: Original | Processed
};
cloudformation.getTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • ChangeSetName — (String)

      The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

    • TemplateStage — (String)

      For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

      If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

      Possible values include:
      • "Original"
      • "Processed"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TemplateBody — (String)

        Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

        AWS CloudFormation returns the same template that was used when the stack was created.

      • StagesAvailable — (Array<String>)

        The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTemplateSummary(params = {}, callback) ⇒ AWS.Request

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Service Reference:

Examples:

Calling the getTemplateSummary operation

var params = {
  StackName: 'STRING_VALUE',
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE'
};
cloudformation.getTemplateSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TemplateBody — (String)

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

    • TemplateURL — (String)

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

    • StackName — (String)

      The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

      Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Parameters — (Array<map>)

        A list of parameter declarations that describe various properties for each parameter.

        • ParameterKey — (String)

          The name that is associated with the parameter.

        • DefaultValue — (String)

          The default value of the parameter.

        • ParameterType — (String)

          The type of parameter.

        • NoEcho — (Boolean)

          Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

        • Description — (String)

          The description that is associate with the parameter.

        • ParameterConstraints — (map)

          The criteria that AWS CloudFormation uses to validate parameter values.

          • AllowedValues — (Array<String>)

            A list of values that are permitted for a parameter.

      • Description — (String)

        The value that is defined in the Description property of the template.

      • Capabilities — (Array<String>)

        The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

        For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

      • CapabilitiesReason — (String)

        The list of resources that generated the values in the Capabilities response element.

      • ResourceTypes — (Array<String>)

        A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

      • Version — (String)

        The AWS template format version, which identifies the capabilities of the template.

      • Metadata — (String)

        The value that is defined for the Metadata property of the template.

      • DeclaredTransforms — (Array<String>)

        A list of the transforms that are declared in the template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listChangeSets(params = {}, callback) ⇒ AWS.Request

Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

Service Reference:

Examples:

Calling the listChangeSets operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
cloudformation.listChangeSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

    • NextToken — (String)

      A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Summaries — (Array<map>)

        A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

        • StackId — (String)

          The ID of the stack with which the change set is associated.

        • StackName — (String)

          The name of the stack with which the change set is associated.

        • ChangeSetId — (String)

          The ID of the change set.

        • ChangeSetName — (String)

          The name of the change set.

        • ExecutionStatus — (String)

          If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

          Possible values include:
          • "UNAVAILABLE"
          • "AVAILABLE"
          • "EXECUTE_IN_PROGRESS"
          • "EXECUTE_COMPLETE"
          • "EXECUTE_FAILED"
          • "OBSOLETE"
        • Status — (String)

          The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

          Possible values include:
          • "CREATE_PENDING"
          • "CREATE_IN_PROGRESS"
          • "CREATE_COMPLETE"
          • "DELETE_COMPLETE"
          • "FAILED"
        • StatusReason — (String)

          A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.

        • CreationTime — (Date)

          The start time when the change set was created, in UTC.

        • Description — (String)

          Descriptive information about the change set.

      • NextToken — (String)

        If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listExports(params = {}, callback) ⇒ AWS.Request

Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.

For more information, see AWS CloudFormation Export Stack Output Values.

Service Reference:

Examples:

Calling the listExports operation

var params = {
  NextToken: 'STRING_VALUE'
};
cloudformation.listExports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Exports — (Array<map>)

        The output for the ListExports action.

        • ExportingStackId — (String)

          The stack that contains the exported output name and value.

        • Name — (String)

          The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

        • Value — (String)

          The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

      • NextToken — (String)

        If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listImports(params = {}, callback) ⇒ AWS.Request

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue function.

Service Reference:

Examples:

Calling the listImports operation

var params = {
  ExportName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
cloudformation.listImports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ExportName — (String)

      The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.

    • NextToken — (String)

      A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Imports — (Array<String>)

        A list of stack names that are importing the specified exported output value.

      • NextToken — (String)

        A string that identifies the next page of exports. If there is no additional page, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listStackResources(params = {}, callback) ⇒ AWS.Request

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

Service Reference:

Examples:

Calling the listStackResources operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
cloudformation.listStackResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stack resources that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackResourceSummaries — (Array<map>)

        A list of StackResourceSummary structures.

        • LogicalResourceIdrequired — (String)

          The logical name of the resource specified in the template.

        • PhysicalResourceId — (String)

          The name or unique identifier that corresponds to a physical instance ID of the resource.

        • ResourceTyperequired — (String)

          Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

        • LastUpdatedTimestamprequired — (Date)

          Time the status was updated.

        • ResourceStatusrequired — (String)

          Current status of the resource.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "DELETE_SKIPPED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

      • NextToken — (String)

        If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listStacks(params = {}, callback) ⇒ AWS.Request

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

Service Reference:

Examples:

Calling the listStacks operation

var params = {
  NextToken: 'STRING_VALUE',
  StackStatusFilter: [
    CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | REVIEW_IN_PROGRESS,
    /* more items */
  ]
};
cloudformation.listStacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

    • StackStatusFilter — (Array<String>)

      Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackSummaries — (Array<map>)

        A list of StackSummary structures containing information about the specified stacks.

        • StackId — (String)

          Unique stack identifier.

        • StackNamerequired — (String)

          The name associated with the stack.

        • TemplateDescription — (String)

          The template description of the template used to create the stack.

        • CreationTimerequired — (Date)

          The time the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • StackStatusrequired — (String)

          The current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/Failure message associated with the stack status.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

setStackPolicy(params = {}, callback) ⇒ AWS.Request

Sets a stack policy for a specified stack.

Service Reference:

Examples:

Calling the setStackPolicy operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  StackPolicyBody: 'STRING_VALUE',
  StackPolicyURL: 'STRING_VALUE'
};
cloudformation.setStackPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or unique stack ID that you want to associate a policy with.

    • StackPolicyBody — (String)

      Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    • StackPolicyURL — (String)

      Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

signalResource(params = {}, callback) ⇒ AWS.Request

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Service Reference:

Examples:

Calling the signalResource operation

var params = {
  LogicalResourceId: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  Status: SUCCESS | FAILURE, /* required */
  UniqueId: 'STRING_VALUE' /* required */
};
cloudformation.signalResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The stack name or unique stack ID that includes the resource that you want to signal.

    • LogicalResourceId — (String)

      The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

    • UniqueId — (String)

      A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

    • Status — (String)

      The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

      Possible values include:
      • "SUCCESS"
      • "FAILURE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateStack(params = {}, callback) ⇒ AWS.Request

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

Service Reference:

Examples:

Calling the updateStack operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM,
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  StackPolicyBody: 'STRING_VALUE',
  StackPolicyDuringUpdateBody: 'STRING_VALUE',
  StackPolicyDuringUpdateURL: 'STRING_VALUE',
  StackPolicyURL: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE',
  UsePreviousTemplate: true || false
};
cloudformation.updateStack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StackName — (String)

      The name or unique stack ID of the stack to update.

    • TemplateBody — (String)

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

      Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    • TemplateURL — (String)

      Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    • UsePreviousTemplate — (Boolean)

      Reuse the existing template that is associated with the stack that you are updating.

      Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    • StackPolicyDuringUpdateBody — (String)

      Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

    • StackPolicyDuringUpdateURL — (String)

      Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

    • Parameters — (Array<map>)

      A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

      • ParameterKey — (String)

        The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The value associated with the parameter.

      • UsePreviousValue — (Boolean)

        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

    • Capabilities — (Array<String>)

      A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

      The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

      For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

    • ResourceTypes — (Array<String>)

      The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

      If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

      If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

    • StackPolicyBody — (String)

      Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

    • StackPolicyURL — (String)

      Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

    • NotificationARNs — (Array<String>)

      Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

    • Tags — (Array<map>)

      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.

      If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.

      • Key — (String)

        Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

      • Value — (String)

        Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

    • ClientRequestToken — (String)

      A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StackId — (String)

        Unique identifier of the stack.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

validateTemplate(params = {}, callback) ⇒ AWS.Request

Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.

Service Reference:

Examples:

Calling the validateTemplate operation

var params = {
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE'
};
cloudformation.validateTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TemplateBody — (String)

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    • TemplateURL — (String)

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

      Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Parameters — (Array<map>)

        A list of TemplateParameter structures.

        • ParameterKey — (String)

          The name associated with the parameter.

        • DefaultValue — (String)

          The default value associated with the parameter.

        • NoEcho — (Boolean)

          Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

        • Description — (String)

          User defined description associated with the parameter.

      • Description — (String)

        The description found within the template.

      • Capabilities — (Array<String>)

        The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

        For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

      • CapabilitiesReason — (String)

        The list of resources that generated the values in the Capabilities response element.

      • DeclaredTransforms — (Array<String>)

        A list of the transforms that are declared in the template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given CloudFormation resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the stackExists state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

cloudformation.waitFor('stackExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacks() operation every 5 seconds (at most 20 times).

Examples:

Waiting for the stackExists state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        A list of stack structures.

        • StackId — (String)

          Unique identifier of the stack.

        • StackNamerequired — (String)

          The name associated with the stack.

        • ChangeSetId — (String)

          The unique ID of the change set.

        • Description — (String)

          A user-defined description associated with the stack.

        • Parameters — (Array<map>)

          A list of Parameter structures.

          • ParameterKey — (String)

            The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The value associated with the parameter.

          • UsePreviousValue — (Boolean)

            During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

        • CreationTimerequired — (Date)

          The time at which the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • StackStatusrequired — (String)

          Current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/failure message associated with the stack status.

        • DisableRollback — (Boolean)

          Boolean to enable or disable rollback on stack creation failures:

          • true: disable rollback

          • false: enable rollback

        • NotificationARNs — (Array<String>)

          SNS topic ARNs to which stack related events are published.

        • TimeoutInMinutes — (Integer)

          The amount of time within which stack creation should complete.

        • Capabilities — (Array<String>)

          The capabilities allowed in the stack.

        • Outputs — (Array<map>)

          A list of output structures.

          • OutputKey — (String)

            The key associated with the output.

          • OutputValue — (String)

            The value associated with the output.

          • Description — (String)

            User defined description associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

        • Tags — (Array<map>)

          A list of Tags that specify information about the stack.

          • Key — (String)

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

          • Value — (String)

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

cloudformation.waitFor('stackCreateComplete', params = {}, [callback]) ⇒ AWS.Request

Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacks() operation every 30 seconds (at most 120 times).

Examples:

Waiting for the stackCreateComplete state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackCreateComplete', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        A list of stack structures.

        • StackId — (String)

          Unique identifier of the stack.

        • StackNamerequired — (String)

          The name associated with the stack.

        • ChangeSetId — (String)

          The unique ID of the change set.

        • Description — (String)

          A user-defined description associated with the stack.

        • Parameters — (Array<map>)

          A list of Parameter structures.

          • ParameterKey — (String)

            The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The value associated with the parameter.

          • UsePreviousValue — (Boolean)

            During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

        • CreationTimerequired — (Date)

          The time at which the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • StackStatusrequired — (String)

          Current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/failure message associated with the stack status.

        • DisableRollback — (Boolean)

          Boolean to enable or disable rollback on stack creation failures:

          • true: disable rollback

          • false: enable rollback

        • NotificationARNs — (Array<String>)

          SNS topic ARNs to which stack related events are published.

        • TimeoutInMinutes — (Integer)

          The amount of time within which stack creation should complete.

        • Capabilities — (Array<String>)

          The capabilities allowed in the stack.

        • Outputs — (Array<map>)

          A list of output structures.

          • OutputKey — (String)

            The key associated with the output.

          • OutputValue — (String)

            The value associated with the output.

          • Description — (String)

            User defined description associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

        • Tags — (Array<map>)

          A list of Tags that specify information about the stack.

          • Key — (String)

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

          • Value — (String)

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

cloudformation.waitFor('stackDeleteComplete', params = {}, [callback]) ⇒ AWS.Request

Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacks() operation every 30 seconds (at most 120 times).

Examples:

Waiting for the stackDeleteComplete state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackDeleteComplete', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        A list of stack structures.

        • StackId — (String)

          Unique identifier of the stack.

        • StackNamerequired — (String)

          The name associated with the stack.

        • ChangeSetId — (String)

          The unique ID of the change set.

        • Description — (String)

          A user-defined description associated with the stack.

        • Parameters — (Array<map>)

          A list of Parameter structures.

          • ParameterKey — (String)

            The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The value associated with the parameter.

          • UsePreviousValue — (Boolean)

            During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

        • CreationTimerequired — (Date)

          The time at which the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • StackStatusrequired — (String)

          Current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/failure message associated with the stack status.

        • DisableRollback — (Boolean)

          Boolean to enable or disable rollback on stack creation failures:

          • true: disable rollback

          • false: enable rollback

        • NotificationARNs — (Array<String>)

          SNS topic ARNs to which stack related events are published.

        • TimeoutInMinutes — (Integer)

          The amount of time within which stack creation should complete.

        • Capabilities — (Array<String>)

          The capabilities allowed in the stack.

        • Outputs — (Array<map>)

          A list of output structures.

          • OutputKey — (String)

            The key associated with the output.

          • OutputValue — (String)

            The value associated with the output.

          • Description — (String)

            User defined description associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

        • Tags — (Array<map>)

          A list of Tags that specify information about the stack.

          • Key — (String)

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

          • Value — (String)

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

cloudformation.waitFor('stackUpdateComplete', params = {}, [callback]) ⇒ AWS.Request

Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacks() operation every 30 seconds (at most 120 times).

Examples:

Waiting for the stackUpdateComplete state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackUpdateComplete', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • StackName — (String)

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

      • Running stacks: You can specify either the stack's name or its unique stack ID.

      • Deleted stacks: You must specify the unique stack ID.

      Default: There is no default value.

    • NextToken — (String)

      A string that identifies the next page of stacks that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stacks — (Array<map>)

        A list of stack structures.

        • StackId — (String)

          Unique identifier of the stack.

        • StackNamerequired — (String)

          The name associated with the stack.

        • ChangeSetId — (String)

          The unique ID of the change set.

        • Description — (String)

          A user-defined description associated with the stack.

        • Parameters — (Array<map>)

          A list of Parameter structures.

          • ParameterKey — (String)

            The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The value associated with the parameter.

          • UsePreviousValue — (Boolean)

            During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

        • CreationTimerequired — (Date)

          The time at which the stack was created.

        • LastUpdatedTime — (Date)

          The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

        • StackStatusrequired — (String)

          Current status of the stack.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "CREATE_COMPLETE"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_COMPLETE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
        • StackStatusReason — (String)

          Success/failure message associated with the stack status.

        • DisableRollback — (Boolean)

          Boolean to enable or disable rollback on stack creation failures:

          • true: disable rollback

          • false: enable rollback

        • NotificationARNs — (Array<String>)

          SNS topic ARNs to which stack related events are published.

        • TimeoutInMinutes — (Integer)

          The amount of time within which stack creation should complete.

        • Capabilities — (Array<String>)

          The capabilities allowed in the stack.

        • Outputs — (Array<map>)

          A list of output structures.

          • OutputKey — (String)

            The key associated with the output.

          • OutputValue — (String)

            The value associated with the output.

          • Description — (String)

            User defined description associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

        • Tags — (Array<map>)

          A list of Tags that specify information about the stack.

          • Key — (String)

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

          • Value — (String)

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • NextToken — (String)

        If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

cloudformation.waitFor('changeSetCreateComplete', params = {}, [callback]) ⇒ AWS.Request

Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSet() operation every 30 seconds (at most 120 times).

Examples:

Waiting for the changeSetCreateComplete state

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
};
cloudformation.waitFor('changeSetCreateComplete', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • ChangeSetName — (String)

      The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    • StackName — (String)

      If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

    • NextToken — (String)

      A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeSetName — (String)

        The name of the change set.

      • ChangeSetId — (String)

        The ARN of the change set.

      • StackId — (String)

        The ARN of the stack that is associated with the change set.

      • StackName — (String)

        The name of the stack that is associated with the change set.

      • Description — (String)

        Information about the change set.

      • Parameters — (Array<map>)

        A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

        • ParameterKey — (String)

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

        • ParameterValue — (String)

          The value associated with the parameter.

        • UsePreviousValue — (Boolean)

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

      • CreationTime — (Date)

        The start time when the change set was created, in UTC.

      • ExecutionStatus — (String)

        If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

        Possible values include:
        • "UNAVAILABLE"
        • "AVAILABLE"
        • "EXECUTE_IN_PROGRESS"
        • "EXECUTE_COMPLETE"
        • "EXECUTE_FAILED"
        • "OBSOLETE"
      • Status — (String)

        The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

        Possible values include:
        • "CREATE_PENDING"
        • "CREATE_IN_PROGRESS"
        • "CREATE_COMPLETE"
        • "DELETE_COMPLETE"
        • "FAILED"
      • StatusReason — (String)

        A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.

      • NotificationARNs — (Array<String>)

        The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

      • Capabilities — (Array<String>)

        If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      • Tags — (Array<map>)

        If you execute the change set, the tags that will be associated with the stack.

        • Key — (String)

          Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

        • Value — (String)

          Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • Changes — (Array<map>)

        A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

        • Type — (String)

          The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.

          Possible values include:
          • "Resource"
        • ResourceChange — (map)

          A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.

          • Action — (String)

            The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

            Possible values include:
            • "Add"
            • "Modify"
            • "Remove"
          • LogicalResourceId — (String)

            The resource's logical ID, which is defined in the stack's template.

          • PhysicalResourceId — (String)

            The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

          • ResourceType — (String)

            The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

          • Replacement — (String)

            For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

            If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

            Possible values include:
            • "True"
            • "False"
            • "Conditional"
          • Scope — (Array<String>)

            For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

          • Details — (Array<map>)

            For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

            • Target — (map)

              A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.

              • Attribute — (String)

                Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

                Possible values include:
                • "Properties"
                • "Metadata"
                • "CreationPolicy"
                • "UpdatePolicy"
                • "DeletionPolicy"
                • "Tags"
              • Name — (String)

                If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

              • RequiresRecreation — (String)

                If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.

                Possible values include:
                • "Never"
                • "Conditionally"
                • "Always"
            • Evaluation — (String)

              Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

              For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

              For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

              Possible values include:
              • "Static"
              • "Dynamic"
            • ChangeSource — (String)

              The group to which the CausingEntity value belongs. There are five entity groups:

              • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.

              • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.

              • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.

              • DirectModification entities are changes that are made directly to the template.

              • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.

              Possible values include:
              • "ResourceReference"
              • "ParameterReference"
              • "ResourceAttribute"
              • "DirectModification"
              • "Automatic"
            • CausingEntity — (String)

              The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

              If the ChangeSource value is DirectModification, no value is given for CausingEntity.

      • NextToken — (String)

        If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also: