You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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.

Service Description

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

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

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

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

Sending a Request Using CloudFormation

var cloudformation = new AWS.CloudFormation();
cloudformation.activateType(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, stackImportComplete, stackRollbackComplete, changeSetCreateComplete, typeRegistrationComplete

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|AWS.Endpoint) —

    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' or an Endpoint object.

  • 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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.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

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

Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Service Reference:

Examples:

Calling the activateType operation

var params = {
  AutoUpdate: true || false,
  ExecutionRoleArn: 'STRING_VALUE',
  LoggingConfig: {
    LogGroupName: 'STRING_VALUE', /* required */
    LogRoleArn: 'STRING_VALUE' /* required */
  },
  MajorVersion: 'NUMBER_VALUE',
  PublicTypeArn: 'STRING_VALUE',
  PublisherId: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE',
  TypeNameAlias: 'STRING_VALUE',
  VersionBump: MAJOR | MINOR
};
cloudformation.activateType(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: {}) —
    • Type — (String)

      The extension type.

      Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • PublicTypeArn — (String)

      The Amazon Resource Number (ARN) of the public extension.

      Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    • PublisherId — (String)

      The ID of the extension publisher.

      Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    • TypeNameAlias — (String)

      An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

      An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

    • AutoUpdate — (Boolean)

      Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

      The default is true.

    • LoggingConfig — (map)

      Contains logging configuration information for an extension.

      • LogRoleArn — required — (String)

        The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

      • LogGroupName — required — (String)

        The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the extension's handlers.

    • ExecutionRoleArn — (String)

      The name of the IAM execution role to use to activate the extension.

    • VersionBump — (String)

      Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

      • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

      • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

      Possible values include:
      • "MAJOR"
      • "MINOR"
    • MajorVersion — (Integer)

      The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

      You can specify MajorVersion or VersionBump, 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. The data object has the following properties:

      • Arn — (String)

        The Amazon Resource Number (ARN) of the activated extension, in this account and region.

Returns:

  • (AWS.Request) —

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

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

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Service Reference:

Examples:

Calling the batchDescribeTypeConfigurations operation

var params = {
  TypeConfigurationIdentifiers: [ /* required */
    {
      Type: RESOURCE | MODULE,
      TypeArn: 'STRING_VALUE',
      TypeConfigurationAlias: 'STRING_VALUE',
      TypeConfigurationArn: 'STRING_VALUE',
      TypeName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
cloudformation.batchDescribeTypeConfigurations(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: {}) —
    • TypeConfigurationIdentifiers — (Array<map>)

      The list of identifiers for the desired extension configurations.

      • TypeArn — (String)

        The Amazon Resource Name (ARN) for the extension, in this account and region.

        For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

      • TypeConfigurationAlias — (String)

        The alias specified for this configuration, if one was specified when the configuration was set.

      • TypeConfigurationArn — (String)

        The Amazon Resource Name (ARN) for the configuration, in this account and region.

      • Type — (String)

        The type of extension.

        Possible values include:
        • "RESOURCE"
        • "MODULE"
      • TypeName — (String)

        The name of the extension type to which this configuration applies.

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:

      • Errors — (Array<map>)

        A list of information concerning any errors generated during the setting of the specified configurations.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The error message.

        • TypeConfigurationIdentifier — (map)

          Identifying information for the configuration of a CloudFormation extension.

          • TypeArn — (String)

            The Amazon Resource Name (ARN) for the extension, in this account and region.

            For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

          • TypeConfigurationAlias — (String)

            The alias specified for this configuration, if one was specified when the configuration was set.

          • TypeConfigurationArn — (String)

            The Amazon Resource Name (ARN) for the configuration, in this account and region.

          • Type — (String)

            The type of extension.

            Possible values include:
            • "RESOURCE"
            • "MODULE"
          • TypeName — (String)

            The name of the extension type to which this configuration applies.

      • UnprocessedTypeConfigurations — (Array<map>)

        A list of any of the specified extension configurations that CloudFormation could not process for any reason.

        • TypeArn — (String)

          The Amazon Resource Name (ARN) for the extension, in this account and region.

          For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

        • TypeConfigurationAlias — (String)

          The alias specified for this configuration, if one was specified when the configuration was set.

        • TypeConfigurationArn — (String)

          The Amazon Resource Name (ARN) for the configuration, in this account and region.

        • Type — (String)

          The type of extension.

          Possible values include:
          • "RESOURCE"
          • "MODULE"
        • TypeName — (String)

          The name of the extension type to which this configuration applies.

      • TypeConfigurations — (Array<map>)

        A list of any of the specified extension configurations from the CloudFormation registry.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the configuration data, in this account and region.

        • Alias — (String)

          The alias specified for this configuration, if one was specified when the configuration was set.

        • Configuration — (String)

          A JSON string specifying the configuration data for the extension, in this account and region.

          If a configuration has not been set for a specified extension, CloudFormation returns {}.

        • LastUpdated — (Date)

          When the configuration data was last updated for this extension.

          If a configuration has not been set for a specified extension, CloudFormation returns null.

        • TypeArn — (String)

          The Amazon Resource Name (ARN) for the extension, in this account and region.

          For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

        • TypeName — (String)

          The name of the extension.

        • IsDefaultConfiguration — (Boolean)

          Whether or not this configuration data is the default configuration for the extension.

Returns:

  • (AWS.Request) —

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

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 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 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 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 CloudFormation. Because 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 Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, 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 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 cancelled. 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 CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. 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 skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

      Note: Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
    • ClientRequestToken — (String)

      A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormationknows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that 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 CloudFormation will create. If you create a change set for an existing stack, 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 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. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, 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. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierachy, set IncludeNestedStacks to True.

Service Reference:

Examples:

Calling the createChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE', /* required */
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND,
    /* more items */
  ],
  ChangeSetType: CREATE | UPDATE | IMPORT,
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  IncludeNestedStacks: true || false,
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourcesToImport: [
    {
      LogicalResourceId: 'STRING_VALUE', /* required */
      ResourceIdentifier: { /* required */
        '<ResourceIdentifierPropertyKey>': 'STRING_VALUE',
        /* '<ResourceIdentifierPropertyKey>': ... */
      },
      ResourceType: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  RollbackConfiguration: {
    MonitoringTimeInMinutes: 'NUMBER_VALUE',
    RollbackTriggers: [
      {
        Arn: 'STRING_VALUE', /* required */
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* 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. 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. 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 or a Systems Manager document. 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, CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • Capabilities — (Array<String>)

      In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

      • CAPABILITY_AUTO_EXPAND

        Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

        Note: This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

        For more information on macros, see Using CloudFormation Macros to Perform Custom Processing on 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling Access with Identity and Access Management in the CloudFormation User Guide.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

    • RollbackConfiguration — (map)

      The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

      • RollbackTriggers — (Array<map>)

        The triggers to monitor during stack creation or update actions.

        By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

        • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

        • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

        • To remove all currently specified triggers, specify an empty list for this parameter.

        If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the rollback trigger.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Type — required — (String)

          The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

      • MonitoringTimeInMinutes — (Integer)

        The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

        The default is 0 minutes.

        If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

        If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

    • NotificationARNs — (Array<String>)

      The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that 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. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

      • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

      • Value — required — (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 CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that 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. To create a change set for an import operation, specify IMPORT.

      If you create a change set for a new stack, 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, 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"
      • "IMPORT"
    • ResourcesToImport — (Array<map>)

      The resources to import into your stack.

      • ResourceType — required — (String)

        The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.

      • LogicalResourceId — required — (String)

        The logical ID of the target resource as specified in the template.

      • ResourceIdentifier — required — (map<String>)

        A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

    • IncludeNestedStacks — (Boolean)

      Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

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 | CAPABILITY_AUTO_EXPAND,
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  DisableRollback: true || false,
  EnableTerminationProtection: true || false,
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  OnFailure: DO_NOTHING | ROLLBACK | DELETE,
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  RollbackConfiguration: {
    MonitoringTimeInMinutes: 'NUMBER_VALUE',
    RollbackTriggers: [
      {
        Arn: 'STRING_VALUE', /* required */
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  StackPolicyBody: 'STRING_VALUE',
  StackPolicyURL: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE',
  TimeoutInMinutes: 'NUMBER_VALUE'
};
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 alphabetical 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 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 or a Systems Manager document. For more information, go to the Template Anatomy in the 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, CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • 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

    • RollbackConfiguration — (map)

      The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

      • RollbackTriggers — (Array<map>)

        The triggers to monitor during stack creation or update actions.

        By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

        • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

        • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

        • To remove all currently specified triggers, specify an empty list for this parameter.

        If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the rollback trigger.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Type — required — (String)

          The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

      • MonitoringTimeInMinutes — (Integer)

        The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

        The default is 0 minutes.

        If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

        If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

    • 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>)

      In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

      • CAPABILITY_AUTO_EXPAND

        Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

        If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

        You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

        Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

        For more information, see Using CloudFormation Macros to Perform Custom Processing on 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 Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).

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

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, 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 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. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

      • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

      • Value — required — (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 CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. 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.

      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    • EnableTerminationProtection — (Boolean)

      Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is disabled on stacks by default.

      For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

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.

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

Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Service Reference:

Examples:

Calling the createStackInstances operation

var params = {
  Regions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StackSetName: 'STRING_VALUE', /* required */
  Accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  CallAs: SELF | DELEGATED_ADMIN,
  DeploymentTargets: {
    Accounts: [
      'STRING_VALUE',
      /* more items */
    ],
    AccountsUrl: 'STRING_VALUE',
    OrganizationalUnitIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ParameterOverrides: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ]
};
cloudformation.createStackInstances(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to create stack instances from.

    • Accounts — (Array<String>)

      [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

      You can specify Accounts or DeploymentTargets, but not both.

    • DeploymentTargets — (map)

      [Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Regions.

      You can specify Accounts or DeploymentTargets, but not both.

      • Accounts — (Array<String>)

        The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

      • AccountsUrl — (String)

        Returns the value of the AccountsUrl property.

      • OrganizationalUnitIds — (Array<String>)

        The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    • Regions — (Array<String>)

      The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.

    • ParameterOverrides — (Array<map>)

      A list of stack set parameters whose values you want to override in the selected stack instances.

      Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

      • To override the current value for a parameter, include the parameter and specify its value.

      • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

      • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

      • To leave all parameters set to their present values, do not specify this property at all.

      During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

      • ParameterKey — (String)

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

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • OperationPreferences — (map)

      Preferences for how CloudFormation performs this stack set operation.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • OperationId — (String)

      The unique identifier for this stack set operation.

      The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

      If you don't specify an operation ID, the SDK generates one automatically.

      Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

      If a token is not provided, the SDK will use a version 4 UUID.
    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The unique identifier for this stack set operation.

Returns:

  • (AWS.Request) —

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

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

Creates a stack set.

Service Reference:

Examples:

Calling the createStackSet operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  AdministrationRoleARN: 'STRING_VALUE',
  AutoDeployment: {
    Enabled: true || false,
    RetainStacksOnAccountRemoval: true || false
  },
  CallAs: SELF | DELEGATED_ADMIN,
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND,
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ExecutionRoleName: 'STRING_VALUE',
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  PermissionModel: SERVICE_MANAGED | SELF_MANAGED,
  StackId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE'
};
cloudformation.createStackSet(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: {}) —
    • StackSetName — (String)

      The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

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

      A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

    • TemplateBody — (String)

      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

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

    • TemplateURL — (String)

      The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

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

    • StackId — (String)

      The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.

    • Parameters — (Array<map>)

      The input parameters for the stack set template.

      • ParameterKey — (String)

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

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • Capabilities — (Array<String>)

      In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
    • Tags — (Array<map>)

      The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

      If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

      • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

      • Value — required — (String)

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

    • AdministrationRoleARN — (String)

      The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

      Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

    • ExecutionRoleName — (String)

      The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

      Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

    • PermissionModel — (String)

      Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

      Possible values include:
      • "SERVICE_MANAGED"
      • "SELF_MANAGED"
    • AutoDeployment — (map)

      Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

      • Enabled — (Boolean)

        If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

      • RetainStacksOnAccountRemoval — (Boolean)

        If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"
    • ClientRequestToken — (String)

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

      If you don't specify an operation ID, the SDK generates one automatically.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • StackSetId — (String)

        The ID of the stack set that you're creating.

Returns:

  • (AWS.Request) —

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

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

Deactivates a public extension that was previously activated in this account and region.

Once deactivated, an extension cannot be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions are not automatically updated if a new version of the extension is released.

Service Reference:

Examples:

Calling the deactivateType operation

var params = {
  Arn: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE'
};
cloudformation.deactivateType(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: {}) —
    • TypeName — (String)

      The type name of the extension, in this account and region. If you specified a type name alias when enabling the extension, use the type name alias.

      Conditional: You must specify either Arn, or TypeName and Type.

    • Type — (String)

      The extension type.

      Conditional: You must specify either Arn, or TypeName and Type.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • Arn — (String)

      The Amazon Resource Name (ARN) for the extension, in this account and region.

      Conditional: You must specify either Arn, or TypeName and 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.

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, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

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, 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 Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

      If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, 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 CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. 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.

      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

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.

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

Deletes stack instances for the specified accounts, in the specified Regions.

Service Reference:

Examples:

Calling the deleteStackInstances operation

var params = {
  Regions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RetainStacks: true || false, /* required */
  StackSetName: 'STRING_VALUE', /* required */
  Accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  CallAs: SELF | DELEGATED_ADMIN,
  DeploymentTargets: {
    Accounts: [
      'STRING_VALUE',
      /* more items */
    ],
    AccountsUrl: 'STRING_VALUE',
    OrganizationalUnitIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
cloudformation.deleteStackInstances(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to delete stack instances for.

    • Accounts — (Array<String>)

      [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

      You can specify Accounts or DeploymentTargets, but not both.

    • DeploymentTargets — (map)

      [Service-managed permissions] The Organizations accounts from which to delete stack instances.

      You can specify Accounts or DeploymentTargets, but not both.

      • Accounts — (Array<String>)

        The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

      • AccountsUrl — (String)

        Returns the value of the AccountsUrl property.

      • OrganizationalUnitIds — (Array<String>)

        The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    • Regions — (Array<String>)

      The Regions where you want to delete stack set instances.

    • OperationPreferences — (map)

      Preferences for how CloudFormation performs this stack set operation.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • RetainStacks — (Boolean)

      Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

      For more information, see Stack set operation options.

    • OperationId — (String)

      The unique identifier for this stack set operation.

      If you don't specify an operation ID, the SDK generates one automatically.

      The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

      Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

      If a token is not provided, the SDK will use a version 4 UUID.
    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The unique identifier for this stack set operation.

Returns:

  • (AWS.Request) —

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

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

Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.

Service Reference:

Examples:

Calling the deleteStackSet operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN
};
cloudformation.deleteStackSet(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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.

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

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

Service Reference:

Examples:

Calling the deregisterType operation

var params = {
  Arn: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
cloudformation.deregisterType(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: {}) —
    • Arn — (String)

      The Amazon Resource Name (ARN) of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • Type — (String)

      The kind of extension.

      Conditional: You must specify either TypeName and Type, or Arn.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • VersionId — (String)

      The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

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 CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Limits in the CloudFormation User Guide.

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 CloudFormation account limits and their values.

        • Name — (String)

          The name of the account limit.

          Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit

        • 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 CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the 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, CloudFormation uses the default value that is specified in your template.

        • ParameterValue — (String)

          The input 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.

        • ResolvedValue — (String)

          Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

      • 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 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_PENDING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
        • "FAILED"
      • StatusReason — (String)

        A description of the change set's status. For example, if your attempt to create a change set failed, 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.

      • RollbackConfiguration — (map)

        The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

        • RollbackTriggers — (Array<map>)

          The triggers to monitor during stack creation or update actions.

          By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

          • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

          • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

          • To remove all currently specified triggers, specify an empty list for this parameter.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the rollback trigger.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

          • Type — required — (String)

            The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

        • MonitoringTimeInMinutes — (Integer)

          The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

          The default is 0 minutes.

          If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

          If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

      • 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

        • Value — required — (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 CloudFormation changes if you execute the change set.

        • Type — (String)

          The type of entity that 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 CloudFormation will perform.

          • Action — (String)

            The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource cannot be determined).

            Possible values include:
            • "Add"
            • "Modify"
            • "Remove"
            • "Import"
            • "Dynamic"
          • 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 CloudFormation resource, such as AWS::S3::Bucket.

          • Replacement — (String)

            For the Modify action, indicates whether 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 CloudFormation will make to the resource.

            • Target — (map)

              A ResourceTargetDefinition structure that describes the field that 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 CloudFormation User Guide.

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

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

              For Static evaluations, 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, 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, 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 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.

          • ChangeSetId — (String)

            The change set ID of the nested change set.

          • ModuleInfo — (map)

            Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

            • TypeHierarchy — (String)

              A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

              In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

              AWS::First::Example::MODULE/AWS::Second::Example::MODULE

            • LogicalIdHierarchy — (String)

              A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

              In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

              moduleA/moduleB

              For more information, see Referencing resources in a module in the CloudFormation User Guide.

      • 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.

      • IncludeNestedStacks — (Boolean)

        Verifies if IncludeNestedStacks is set to True.

      • ParentChangeSetId — (String)

        Specifies the change set ID of the parent change set in the current nested change set hierarchy.

      • RootChangeSetId — (String)

        Specifies the change set ID of the root change set in the current nested change set hierarchy.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns information about a CloudFormation extension publisher.

If you do not supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information on registering as a publisher, see:

Service Reference:

Examples:

Calling the describePublisher operation

var params = {
  PublisherId: 'STRING_VALUE'
};
cloudformation.describePublisher(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: {}) —
    • PublisherId — (String)

      The ID of the extension publisher.

      If you do not supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

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:

      • PublisherId — (String)

        The ID of the extension publisher.

      • PublisherStatus — (String)

        Whether the publisher is verified. Currently, all registered publishers are verified.

        Possible values include:
        • "VERIFIED"
        • "UNVERIFIED"
      • IdentityProvider — (String)

        The type of account used as the identity provider when registering this publisher with CloudFormation.

        Possible values include:
        • "AWS_Marketplace"
        • "GitHub"
        • "Bitbucket"
      • PublisherProfile — (String)

        The URL to the publisher's profile with the identity provider.

Returns:

  • (AWS.Request) —

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

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

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

Service Reference:

Examples:

Calling the describeStackDriftDetectionStatus operation

var params = {
  StackDriftDetectionId: 'STRING_VALUE' /* required */
};
cloudformation.describeStackDriftDetectionStatus(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: {}) —
    • StackDriftDetectionId — (String)

      The ID of the drift detection results of this operation.

      CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

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)

        The ID of the stack.

      • StackDriftDetectionId — (String)

        The ID of the drift detection results of this operation.

        CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

      • StackDriftStatus — (String)

        Status of the stack's actual configuration compared to its expected configuration.

        • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

        • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

        • IN_SYNC: The stack's actual configuration matches its expected template configuration.

        • UNKNOWN: This value is reserved for future use.

        Possible values include:
        • "DRIFTED"
        • "IN_SYNC"
        • "UNKNOWN"
        • "NOT_CHECKED"
      • DetectionStatus — (String)

        The status of the stack drift detection operation.

        • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)

          If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

        • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

        • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

        Possible values include:
        • "DETECTION_IN_PROGRESS"
        • "DETECTION_FAILED"
        • "DETECTION_COMPLETE"
      • DetectionStatusReason — (String)

        The reason the stack drift detection operation has its current status.

      • DriftedStackResourceCount — (Integer)

        Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

      • Timestamp — (Date)

        Time at which the stack drift detection operation was initiated.

Returns:

  • (AWS.Request) —

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

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 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.

        • StackId — required — (String)

          The unique ID name of the instance of the stack.

        • EventId — required — (String)

          The unique ID of this event.

        • StackName — required — (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 Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

        • Timestamp — required — (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"
          • "IMPORT_FAILED"
          • "IMPORT_COMPLETE"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_FAILED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_COMPLETE"
          • "ROLLBACK_FAILED"
        • 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.

          All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. 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.

          In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

      • 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.

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

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

Service Reference:

Examples:

Calling the describeStackInstance operation

var params = {
  StackInstanceAccount: 'STRING_VALUE', /* required */
  StackInstanceRegion: 'STRING_VALUE', /* required */
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN
};
cloudformation.describeStackInstance(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: {}) —
    • StackSetName — (String)

      The name or the unique stack ID of the stack set that you want to get stack instance information for.

    • StackInstanceAccount — (String)

      The ID of an Amazon Web Services account that's associated with this stack instance.

    • StackInstanceRegion — (String)

      The name of a Region that's associated with this stack instance.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • StackInstance — (map)

        The stack instance that matches the specified request parameters.

        • StackSetId — (String)

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

        • Region — (String)

          The name of the Amazon Web Services Region that the stack instance is associated with.

        • Account — (String)

          [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

        • StackId — (String)

          The ID of the stack instance.

        • ParameterOverrides — (Array<map>)

          A list of parameters from the stack set template whose values have been overridden in this stack instance.

          • ParameterKey — (String)

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

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • Status — (String)

          The status of the stack instance, in terms of its synchronization with its associated stack set.

          • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

          • OUTDATED: The stack isn't currently up to date with the stack set because:

            • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

            • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

          • CURRENT: The stack is currently up to date with the stack set.

          Possible values include:
          • "CURRENT"
          • "OUTDATED"
          • "INOPERABLE"
        • StackInstanceStatus — (map)

          The detailed status of the stack instance.

          • DetailedStatus — (String)

            • CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

            • FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

            • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

            • PENDING: The operation in the specified account and Region has yet to start.

            • RUNNING: The operation in the specified account and Region is currently in progress.

            • SUCCEEDED: The operation in the specified account and Region completed successfully.

            Possible values include:
            • "PENDING"
            • "RUNNING"
            • "SUCCEEDED"
            • "FAILED"
            • "CANCELLED"
            • "INOPERABLE"
        • StatusReason — (String)

          The explanation for the specific status code that is assigned to this stack instance.

        • OrganizationalUnitId — (String)

          [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

        • DriftStatus — (String)

          Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

          • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

          • NOT_CHECKED: CloudFormation has not checked if the stack instance differs from its expected stack set configuration.

          • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.

          • UNKNOWN: This value is reserved for future use.

          Possible values include:
          • "DRIFTED"
          • "IN_SYNC"
          • "UNKNOWN"
          • "NOT_CHECKED"
        • LastDriftCheckTimestamp — (Date)

          Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.

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.

        • LogicalResourceId — required — (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 CloudFormation.

        • ResourceType — required — (String)

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

        • LastUpdatedTimestamp — required — (Date)

          Time the status was updated.

        • ResourceStatus — required — (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"
          • "IMPORT_FAILED"
          • "IMPORT_COMPLETE"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_FAILED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_COMPLETE"
          • "ROLLBACK_FAILED"
        • 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 CloudFormation User Guide.

        • DriftInformation — (map)

          Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackResourceDriftStatus — required — (String)

            Status of the resource's actual configuration compared to its expected configuration

            • DELETED: The resource differs from its expected configuration in that it has been deleted.

            • MODIFIED: The resource differs from its expected configuration.

            • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

              Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.

            • IN_SYNC: The resources's actual configuration matches its expected configuration.

            Possible values include:
            • "IN_SYNC"
            • "MODIFIED"
            • "DELETED"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            When CloudFormation last checked if the resource had drifted from its expected configuration.

        • ModuleInfo — (map)

          Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

          • TypeHierarchy — (String)

            A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

            AWS::First::Example::MODULE/AWS::Second::Example::MODULE

          • LogicalIdHierarchy — (String)

            A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

            moduleA/moduleB

            For more information, see Referencing resources in a module in the CloudFormation User Guide.

Returns:

  • (AWS.Request) —

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

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

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

Service Reference:

Examples:

Calling the describeStackResourceDrifts operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StackResourceDriftStatusFilters: [
    IN_SYNC | MODIFIED | DELETED | NOT_CHECKED,
    /* more items */
  ]
};
cloudformation.describeStackResourceDrifts(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 of the stack for which you want drift information.

    • StackResourceDriftStatusFilters — (Array<String>)

      The resource drift status values to use as filters for the resource drift results returned.

      • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected template values.

      • IN_SYNC: The resources's actual configuration matches its expected template configuration.

      • NOT_CHECKED: CloudFormation does not currently return this value.

    • NextToken — (String)

      A string that identifies the next page of stack resource drift results.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

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:

      • StackResourceDrifts — (Array<map>)

        Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

        For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

        • StackId — required — (String)

          The ID of the stack.

        • LogicalResourceId — required — (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 CloudFormation.

        • PhysicalResourceIdContext — (Array<map>)

          Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

          • Key — required — (String)

            The resource context key.

          • Value — required — (String)

            The resource context value.

        • ResourceType — required — (String)

          The type of the resource.

        • ExpectedProperties — (String)

          A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

          For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

        • ActualProperties — (String)

          A JSON structure containing the actual property values of the stack resource.

          For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

        • PropertyDifferences — (Array<map>)

          A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

          • PropertyPath — required — (String)

            The fully-qualified path to the resource property.

          • ExpectedValue — required — (String)

            The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

          • ActualValue — required — (String)

            The actual property value of the resource property.

          • DifferenceType — required — (String)

            The type of property difference.

            • ADD: A value has been added to a resource property that is an array or list data type.

            • REMOVE: The property has been removed from the current resource configuration.

            • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

            Possible values include:
            • "ADD"
            • "REMOVE"
            • "NOT_EQUAL"
        • StackResourceDriftStatus — required — (String)

          Status of the resource's actual configuration compared to its expected configuration

          • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

          • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

          • IN_SYNC: The resources's actual configuration matches its expected template configuration.

          • NOT_CHECKED: CloudFormation does not currently return this value.

          Possible values include:
          • "IN_SYNC"
          • "MODIFIED"
          • "DELETED"
          • "NOT_CHECKED"
        • Timestamp — required — (Date)

          Time at which CloudFormation performed drift detection on the stack resource.

        • ModuleInfo — (map)

          Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

          • TypeHierarchy — (String)

            A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

            AWS::First::Example::MODULE/AWS::Second::Example::MODULE

          • LogicalIdHierarchy — (String)

            A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

            moduleA/moduleB

            For more information, see Referencing resources in a module in the CloudFormation User Guide.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns Amazon Web Services 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 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 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.

        • LogicalResourceId — required — (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 CloudFormation.

        • ResourceType — required — (String)

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

        • Timestamp — required — (Date)

          Time the status was updated.

        • ResourceStatus — required — (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"
          • "IMPORT_FAILED"
          • "IMPORT_COMPLETE"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_FAILED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_COMPLETE"
          • "ROLLBACK_FAILED"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

        • Description — (String)

          User defined description associated with the resource.

        • DriftInformation — (map)

          Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackResourceDriftStatus — required — (String)

            Status of the resource's actual configuration compared to its expected configuration

            • DELETED: The resource differs from its expected configuration in that it has been deleted.

            • MODIFIED: The resource differs from its expected configuration.

            • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

              Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.

            • IN_SYNC: The resources's actual configuration matches its expected configuration.

            Possible values include:
            • "IN_SYNC"
            • "MODIFIED"
            • "DELETED"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            When CloudFormation last checked if the resource had drifted from its expected configuration.

        • ModuleInfo — (map)

          Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

          • TypeHierarchy — (String)

            A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

            AWS::First::Example::MODULE/AWS::Second::Example::MODULE

          • LogicalIdHierarchy — (String)

            A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

            moduleA/moduleB

            For more information, see Referencing resources in a module in the CloudFormation User Guide.

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 ValidationError 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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:

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

Returns the description of the specified stack set.

Service Reference:

Examples:

Calling the describeStackSet operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN
};
cloudformation.describeStackSet(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set whose description you want.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • StackSet — (map)

        The specified stack set.

        • StackSetName — (String)

          The name that's associated with the stack set.

        • StackSetId — (String)

          The ID of the stack set.

        • Description — (String)

          A description of the stack set that you specify when the stack set is created or updated.

        • Status — (String)

          The status of the stack set.

          Possible values include:
          • "ACTIVE"
          • "DELETED"
        • TemplateBody — (String)

          The structure that contains the body of the template that was used to create or update the stack set.

        • Parameters — (Array<map>)

          A list of input parameters for a stack set.

          • ParameterKey — (String)

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

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • Capabilities — (Array<String>)

          The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

        • Tags — (Array<map>)

          A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

          • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • StackSetARN — (String)

          The Amazon Resource Number (ARN) of the stack set.

        • AdministrationRoleARN — (String)

          The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.

          Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

        • ExecutionRoleName — (String)

          The name of the IAM execution role used to create or update the stack set.

          Use customized execution roles to control which stack resources users and groups can include in their stack sets.

        • StackSetDriftDetectionDetails — (map)

          Detailed information about the drift status of the stack set.

          For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.

          • DriftStatus — (String)

            Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

            • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

            • NOT_CHECKED: CloudFormation has not checked the stack set for drift.

            • IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "NOT_CHECKED"
          • DriftDetectionStatus — (String)

            The status of the stack set drift detection operation.

            • COMPLETED: The drift detection operation completed without failing on any stack instances.

            • FAILED: The drift detection operation exceeded the specified failure tolerance.

            • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

            • IN_PROGRESS: The drift detection operation is currently being performed.

            • STOPPED: The user has cancelled the drift detection operation.

            Possible values include:
            • "COMPLETED"
            • "FAILED"
            • "PARTIAL_SUCCESS"
            • "IN_PROGRESS"
            • "STOPPED"
          • LastDriftCheckTimestamp — (Date)

            Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.

          • TotalStackInstancesCount — (Integer)

            The total number of stack instances belonging to this stack set.

            The total number of stack instances is equal to the total of:

            • Stack instances that match the stack set configuration.

            • Stack instances that have drifted from the stack set configuration.

            • Stack instances where the drift detection operation has failed.

            • Stack instances currently being checked for drift.

          • DriftedStackInstancesCount — (Integer)

            The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack do not match their expected configuration.

          • InSyncStackInstancesCount — (Integer)

            The number of stack instances which match the expected template and parameter configuration of the stack set.

          • InProgressStackInstancesCount — (Integer)

            The number of stack instances that are currently being checked for drift.

          • FailedStackInstancesCount — (Integer)

            The number of stack instances for which the drift detection operation failed.

        • AutoDeployment — (map)

          [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

          • Enabled — (Boolean)

            If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

          • RetainStacksOnAccountRemoval — (Boolean)

            If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

        • PermissionModel — (String)

          Describes how the IAM roles required for stack set operations are created.

          Possible values include:
          • "SERVICE_MANAGED"
          • "SELF_MANAGED"
        • OrganizationalUnitIds — (Array<String>)

          [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Returns:

  • (AWS.Request) —

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

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

Returns the description of the specified stack set operation.

Service Reference:

Examples:

Calling the describeStackSetOperation operation

var params = {
  OperationId: 'STRING_VALUE', /* required */
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN
};
cloudformation.describeStackSetOperation(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: {}) —
    • StackSetName — (String)

      The name or the unique stack ID of the stack set for the stack operation.

    • OperationId — (String)

      The unique ID of the stack set operation.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • StackSetOperation — (map)

        The specified stack set operation.

        • OperationId — (String)

          The unique ID of a stack set operation.

        • StackSetId — (String)

          The ID of the stack set.

        • Action — (String)

          The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

          Possible values include:
          • "CREATE"
          • "UPDATE"
          • "DELETE"
          • "DETECT_DRIFT"
        • Status — (String)

          The status of the operation.

          • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

          • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

          • RUNNING: The operation is currently being performed.

          • STOPPED: The user has cancelled the operation.

          • STOPPING: The operation is in the process of stopping, at user request.

          • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

          Possible values include:
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
          • "STOPPING"
          • "STOPPED"
          • "QUEUED"
        • OperationPreferences — (map)

          The preferences for how CloudFormation performs this stack set operation.

          • RegionConcurrencyType — (String)

            The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

            Possible values include:
            • "SEQUENTIAL"
            • "PARALLEL"
          • RegionOrder — (Array<String>)

            The order of the Regions in where you want to perform the stack operation.

          • FailureToleranceCount — (Integer)

            The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

            Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

            By default, 0 is specified.

          • FailureTolerancePercentage — (Integer)

            The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

            When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

            Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

            By default, 0 is specified.

          • MaxConcurrentCount — (Integer)

            The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

            Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

            Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

            By default, 1 is specified.

          • MaxConcurrentPercentage — (Integer)

            The maximum percentage of accounts in which to perform this operation at one time.

            When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

            Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

            Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

            By default, 1 is specified.

        • RetainStacks — (Boolean)

          For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.

        • AdministrationRoleARN — (String)

          The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.

          Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

        • ExecutionRoleName — (String)

          The name of the IAM execution role used to create or update the stack set.

          Use customized execution roles to control which stack resources users and groups can include in their stack sets.

        • CreationTimestamp — (Date)

          The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

        • EndTimestamp — (Date)

          The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

        • DeploymentTargets — (map)

          [Service-managed permissions] The Organizations accounts affected by the stack operation.

          • Accounts — (Array<String>)

            The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

          • AccountsUrl — (String)

            Returns the value of the AccountsUrl property.

          • OrganizationalUnitIds — (Array<String>)

            The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

        • StackSetDriftDetectionDetails — (map)

          Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

          this information will only be present for stack set operations whose Action type is DETECT_DRIFT.

          For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.

          • DriftStatus — (String)

            Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

            • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

            • NOT_CHECKED: CloudFormation has not checked the stack set for drift.

            • IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "NOT_CHECKED"
          • DriftDetectionStatus — (String)

            The status of the stack set drift detection operation.

            • COMPLETED: The drift detection operation completed without failing on any stack instances.

            • FAILED: The drift detection operation exceeded the specified failure tolerance.

            • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

            • IN_PROGRESS: The drift detection operation is currently being performed.

            • STOPPED: The user has cancelled the drift detection operation.

            Possible values include:
            • "COMPLETED"
            • "FAILED"
            • "PARTIAL_SUCCESS"
            • "IN_PROGRESS"
            • "STOPPED"
          • LastDriftCheckTimestamp — (Date)

            Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.

          • TotalStackInstancesCount — (Integer)

            The total number of stack instances belonging to this stack set.

            The total number of stack instances is equal to the total of:

            • Stack instances that match the stack set configuration.

            • Stack instances that have drifted from the stack set configuration.

            • Stack instances where the drift detection operation has failed.

            • Stack instances currently being checked for drift.

          • DriftedStackInstancesCount — (Integer)

            The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack do not match their expected configuration.

          • InSyncStackInstancesCount — (Integer)

            The number of stack instances which match the expected template and parameter configuration of the stack set.

          • InProgressStackInstancesCount — (Integer)

            The number of stack instances that are currently being checked for drift.

          • FailedStackInstancesCount — (Integer)

            The number of stack instances for which the drift detection operation failed.

Returns:

  • (AWS.Request) —

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

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

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Service Reference:

Examples:

Calling the describeType operation

var params = {
  Arn: 'STRING_VALUE',
  PublicVersionNumber: 'STRING_VALUE',
  PublisherId: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
cloudformation.describeType(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: {}) —
    • Type — (String)

      The kind of extension.

      Conditional: You must specify either TypeName and Type, or Arn.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • VersionId — (String)

      The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

      If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

    • PublisherId — (String)

      The publisher ID of the extension publisher.

      Extensions provided by Amazon are not assigned a publisher ID.

    • PublicVersionNumber — (String)

      The version number of a public third-party extension.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the extension.

      • Type — (String)

        The kind of extension.

        Possible values include:
        • "RESOURCE"
        • "MODULE"
      • TypeName — (String)

        The name of the extension.

        If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

      • DefaultVersionId — (String)

        The ID of the default version of the extension. The default version is used when the extension version is not specified.

        This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

        To set the default version of an extension, use SetTypeDefaultVersion .

      • IsDefaultVersion — (Boolean)

        Whether the specified extension version is set as the default version.

        This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns null.

      • TypeTestsStatus — (String)

        The contract test status of the registered extension version. To return the extension test status of a specifc extension version, you must specify VersionId.

        This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

        • PASSED: The extension has passed all its contract tests.

          An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.

        • FAILED: The extension has failed one or more contract tests.

        • IN_PROGRESS: Contract tests are currently being performed on the extension.

        • NOT_TESTED: Contract tests have not been performed on the extension.

        Possible values include:
        • "PASSED"
        • "FAILED"
        • "IN_PROGRESS"
        • "NOT_TESTED"
      • TypeTestsStatusDescription — (String)

        The description of the test status. To return the extension test status of a specifc extension version, you must specify VersionId.

        This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

      • Description — (String)

        The description of the extension.

      • Schema — (String)

        The schema that defines the extension.

        For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

      • ProvisioningType — (String)

        For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

        Valid values include:

        • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

        • IMMUTABLE: The resource type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

        • NON_PROVISIONABLE: The resource type does not include all of the following handlers, and therefore cannot actually be provisioned.

          • create

          • read

          • delete

        Possible values include:
        • "NON_PROVISIONABLE"
        • "IMMUTABLE"
        • "FULLY_MUTABLE"
      • DeprecatedStatus — (String)

        The deprecation status of the extension version.

        Valid values include:

        • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

        • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

        For public third-party extensions, CloudFormation returns null.

        Possible values include:
        • "LIVE"
        • "DEPRECATED"
      • LoggingConfig — (map)

        Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

        • LogRoleArn — required — (String)

          The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

        • LogGroupName — required — (String)

          The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the extension's handlers.

      • RequiredActivatedTypes — (Array<map>)

        For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

        • TypeNameAlias — (String)

          An alias assigned to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

        • OriginalTypeName — (String)

          The type name of the public extension.

          If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

        • PublisherId — (String)

          The publisher ID of the extension publisher.

        • SupportedMajorVersions — (Array<Integer>)

          A list of the major versions of the extension type that the macro supports.

      • ExecutionRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

        If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

      • Visibility — (String)

        The scope at which the extension is visible and usable in CloudFormation operations.

        Valid values include:

        • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

        • PUBLIC: The extension is publically visible and usable within any Amazon account.

        Possible values include:
        • "PUBLIC"
        • "PRIVATE"
      • SourceUrl — (String)

        The URL of the source code for the extension.

      • DocumentationUrl — (String)

        The URL of a page providing detailed documentation for this extension.

      • LastUpdated — (Date)

        When the specified extension version was registered. This applies only to:

        • Private extensions you have registered in your account. For more information, see RegisterType.

        • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

      • TimeCreated — (Date)

        When the specified private extension version was registered or activated in your account.

      • ConfigurationSchema — (String)

        A JSON string that represent the current configuration data for the extension in this account and region.

        To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

      • PublisherId — (String)

        The publisher ID of the extension publisher.

        This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon, CloudFormation returns null.

      • OriginalTypeName — (String)

        For public extensions that have been activated for this account and region, the type name of the public extension.

        If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

      • OriginalTypeArn — (String)

        For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

      • PublicVersionNumber — (String)

        The version number of a public third-party extension.

        This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

      • LatestPublicVersion — (String)

        The latest version of a public extension that is available for use.

        This only applies if you specify a public extension, and you do not specify a version. For all other requests, CloudFormation returns null.

      • IsActivated — (Boolean)

        Whether or not the extension is activated in the account and region.

        This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

      • AutoUpdate — (Boolean)

        Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

Returns:

  • (AWS.Request) —

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

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

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

Service Reference:

Examples:

Calling the describeTypeRegistration operation

var params = {
  RegistrationToken: 'STRING_VALUE' /* required */
};
cloudformation.describeTypeRegistration(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: {}) —
    • RegistrationToken — (String)

      The identifier for this registration request.

      This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

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:

      • ProgressStatus — (String)

        The current status of the extension registration request.

        Possible values include:
        • "COMPLETE"
        • "IN_PROGRESS"
        • "FAILED"
      • Description — (String)

        The description of the extension registration request.

      • TypeArn — (String)

        The Amazon Resource Name (ARN) of the extension being registered.

        For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

      • TypeVersionArn — (String)

        The Amazon Resource Name (ARN) of this specific version of the extension being registered.

        For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

Service Reference:

Examples:

Calling the detectStackDrift operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  LogicalResourceIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudformation.detectStackDrift(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 of the stack for which you want to detect drift.

    • LogicalResourceIds — (Array<String>)

      The logical names of any resources you want to use as filters.

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:

      • StackDriftDetectionId — (String)

        The ID of the drift detection results of this operation.

        CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

Returns:

  • (AWS.Request) —

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

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

Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Service Reference:

Examples:

Calling the detectStackResourceDrift operation

var params = {
  LogicalResourceId: 'STRING_VALUE', /* required */
  StackName: 'STRING_VALUE' /* required */
};
cloudformation.detectStackResourceDrift(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 of the stack to which the resource belongs.

    • LogicalResourceId — (String)

      The logical name of the resource for which to return drift information.

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:

      • StackResourceDrift — (map)

        Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

        • StackId — required — (String)

          The ID of the stack.

        • LogicalResourceId — required — (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 CloudFormation.

        • PhysicalResourceIdContext — (Array<map>)

          Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

          • Key — required — (String)

            The resource context key.

          • Value — required — (String)

            The resource context value.

        • ResourceType — required — (String)

          The type of the resource.

        • ExpectedProperties — (String)

          A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

          For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

        • ActualProperties — (String)

          A JSON structure containing the actual property values of the stack resource.

          For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

        • PropertyDifferences — (Array<map>)

          A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

          • PropertyPath — required — (String)

            The fully-qualified path to the resource property.

          • ExpectedValue — required — (String)

            The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

          • ActualValue — required — (String)

            The actual property value of the resource property.

          • DifferenceType — required — (String)

            The type of property difference.

            • ADD: A value has been added to a resource property that is an array or list data type.

            • REMOVE: The property has been removed from the current resource configuration.

            • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

            Possible values include:
            • "ADD"
            • "REMOVE"
            • "NOT_EQUAL"
        • StackResourceDriftStatus — required — (String)

          Status of the resource's actual configuration compared to its expected configuration

          • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

          • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

          • IN_SYNC: The resources's actual configuration matches its expected template configuration.

          • NOT_CHECKED: CloudFormation does not currently return this value.

          Possible values include:
          • "IN_SYNC"
          • "MODIFIED"
          • "DELETED"
          • "NOT_CHECKED"
        • Timestamp — required — (Date)

          Time at which CloudFormation performed drift detection on the stack resource.

        • ModuleInfo — (map)

          Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

          • TypeHierarchy — (String)

            A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

            AWS::First::Example::MODULE/AWS::Second::Example::MODULE

          • LogicalIdHierarchy — (String)

            A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

            moduleA/moduleB

            For more information, see Referencing resources in a module in the CloudFormation User Guide.

Returns:

  • (AWS.Request) —

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

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

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)

  • Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation .

Service Reference:

Examples:

Calling the detectStackSetDrift operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN,
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
cloudformation.detectStackSetDrift(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: {}) —
    • StackSetName — (String)

      The name of the stack set on which to perform the drift detection operation.

    • OperationPreferences — (map)

      The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • OperationId — (String)

      The ID of the stack set operation.

      If a token is not provided, the SDK will use a version 4 UUID.
    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The ID of the drift detection stack set operation.

        you can use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation.

Returns:

  • (AWS.Request) —

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

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

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services 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',
      ResolvedValue: '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 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 or a Systems Manager document. For more information, go to Template Anatomy in the 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, CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

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 Amazon Web Services 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, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, 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, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierachy, IncludeNestedStacks must have been set to True.

Service Reference:

Examples:

Calling the executeChangeSet operation

var params = {
  ChangeSetName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  DisableRollback: true || false,
  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 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 CloudFormation successfully received them.

    • DisableRollback — (Boolean)

      Preserves the state of previously provisioned resources when an operation fails.

      Default: True

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:

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 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 CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

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

      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 CloudFormation User Guide.)

        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 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 or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or 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 = {
  CallAs: SELF | DELEGATED_ADMIN,
  StackName: 'STRING_VALUE',
  StackSetName: '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 CloudFormation User Guide.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, 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 or a Systems Manager document. For more information about templates, see Template Anatomy in the CloudFormation User Guide.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, 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, StackSetName, TemplateBody, or TemplateURL.

    • StackSetName — (String)

      The name or unique ID of the stack set from which the stack was created.

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

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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 Amazon Web Services Management Console.

        • Description — (String)

          The description that is associate with the parameter.

        • ParameterConstraints — (map)

          The criteria that 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 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 Amazon Web Services 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.

      • ResourceIdentifierSummaries — (Array<map>)

        A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

        • ResourceType — (String)

          The template resource type of the target resources, such as AWS::S3::Bucket.

        • LogicalResourceIds — (Array<String>)

          The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

        • ResourceIdentifiers — (Array<String>)

          The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

Returns:

  • (AWS.Request) —

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

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

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

Note: ImportStacksToStackSet is only supported by self-managed permissions.

Service Reference:

Examples:

Calling the importStacksToStackSet operation

var params = {
  StackIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN,
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
cloudformation.importStacksToStackSet(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: {}) —
    • StackSetName — (String)

      The name of the stack set. The name must be unique in the Region where you create your stack set.

    • StackIds — (Array<String>)

      The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.

    • OperationPreferences — (map)

      The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • OperationId — (String)

      A unique, user defined, identifier for the stack set operation.

      If a token is not provided, the SDK will use a version 4 UUID.
    • CallAs — (String)

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • For service managed stack sets, specify DELEGATED_ADMIN.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The unique identifier for the stack set operation.

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, 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 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_PENDING"
          • "DELETE_IN_PROGRESS"
          • "DELETE_COMPLETE"
          • "DELETE_FAILED"
          • "FAILED"
        • StatusReason — (String)

          A description of the change set's status. For example, if your change set is in the FAILED state, 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.

        • IncludeNestedStacks — (Boolean)

          Specifies the current setting of IncludeNestedStacks for the change set.

        • ParentChangeSetId — (String)

          The parent change set ID.

        • RootChangeSetId — (String)

          The root change set ID.

      • 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 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. 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.

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

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.

Service Reference:

Examples:

Calling the listStackInstances operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN,
  Filters: [
    {
      Name: DETAILED_STATUS,
      Values: 'STRING_VALUE'
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StackInstanceAccount: 'STRING_VALUE',
  StackInstanceRegion: 'STRING_VALUE'
};
cloudformation.listStackInstances(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to list stack instances for.

    • NextToken — (String)

      If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • Filters — (Array<map>)

      The status that stack instances are filtered by.

      • Name — (String)

        The type of filter to apply.

        Possible values include:
        • "DETAILED_STATUS"
      • Values — (String)

        The status to filter by.

    • StackInstanceAccount — (String)

      The name of the Amazon Web Services account that you want to list stack instances for.

    • StackInstanceRegion — (String)

      The name of the Region where you want to list stack instances.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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 StackInstanceSummary structures that contain information about the specified stack instances.

        • StackSetId — (String)

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

        • Region — (String)

          The name of the Amazon Web Services Region that the stack instance is associated with.

        • Account — (String)

          [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

        • StackId — (String)

          The ID of the stack instance.

        • Status — (String)

          The status of the stack instance, in terms of its synchronization with its associated stack set.

          • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

          • OUTDATED: The stack isn't currently up to date with the stack set because:

            • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

            • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

          • CURRENT: The stack is currently up to date with the stack set.

          Possible values include:
          • "CURRENT"
          • "OUTDATED"
          • "INOPERABLE"
        • StatusReason — (String)

          The explanation for the specific status code assigned to this stack instance.

        • StackInstanceStatus — (map)

          The detailed status of the stack instance.

          • DetailedStatus — (String)

            • CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

            • FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

            • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

            • PENDING: The operation in the specified account and Region has yet to start.

            • RUNNING: The operation in the specified account and Region is currently in progress.

            • SUCCEEDED: The operation in the specified account and Region completed successfully.

            Possible values include:
            • "PENDING"
            • "RUNNING"
            • "SUCCEEDED"
            • "FAILED"
            • "CANCELLED"
            • "INOPERABLE"
        • OrganizationalUnitId — (String)

          [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

        • DriftStatus — (String)

          Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

          • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

          • NOT_CHECKED: CloudFormation has not checked if the stack instance differs from its expected stack set configuration.

          • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.

          • UNKNOWN: This value is reserved for future use.

          Possible values include:
          • "DRIFTED"
          • "IN_SYNC"
          • "UNKNOWN"
          • "NOT_CHECKED"
        • LastDriftCheckTimestamp — (Date)

          Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to 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.

        • LogicalResourceId — required — (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.

        • ResourceType — required — (String)

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

        • LastUpdatedTimestamp — required — (Date)

          Time the status was updated.

        • ResourceStatus — required — (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"
          • "IMPORT_FAILED"
          • "IMPORT_COMPLETE"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "UPDATE_ROLLBACK_FAILED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_COMPLETE"
          • "ROLLBACK_FAILED"
        • ResourceStatusReason — (String)

          Success/failure message associated with the resource.

        • DriftInformation — (map)

          Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackResourceDriftStatus — required — (String)

            Status of the resource's actual configuration compared to its expected configuration

            • DELETED: The resource differs from its expected configuration in that it has been deleted.

            • MODIFIED: The resource differs from its expected configuration.

            • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

              Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.

            • IN_SYNC: The resources's actual configuration matches its expected configuration.

            Possible values include:
            • "IN_SYNC"
            • "MODIFIED"
            • "DELETED"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            When CloudFormation last checked if the resource had drifted from its expected configuration.

        • ModuleInfo — (map)

          Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

          • TypeHierarchy — (String)

            A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

            AWS::First::Example::MODULE/AWS::Second::Example::MODULE

          • LogicalIdHierarchy — (String)

            A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

            In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

            moduleA/moduleB

            For more information, see Referencing resources in a module in the CloudFormation User Guide.

      • 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_FAILED | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | REVIEW_IN_PROGRESS | IMPORT_IN_PROGRESS | IMPORT_COMPLETE | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE,
    /* 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.

        • StackName — required — (String)

          The name associated with the stack.

        • TemplateDescription — (String)

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

        • CreationTime — required — (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.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • StackStatusReason — (String)

          Success/Failure message associated with the stack status.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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.

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

Returns summary information about the results of a stack set operation.

Service Reference:

Examples:

Calling the listStackSetOperationResults operation

var params = {
  OperationId: 'STRING_VALUE', /* required */
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudformation.listStackSetOperationResults(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to get operation results for.

    • OperationId — (String)

      The ID of the stack set operation.

    • NextToken — (String)

      If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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 StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Regions that are included in the operation.

        • Account — (String)

          [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

        • Region — (String)

          The name of the Amazon Web Services Region for this operation result.

        • Status — (String)

          The result status of the stack set operation for the given account in the given Region.

          • CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

          • FAILED: The operation in the specified account and Region failed.

            If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

          • RUNNING: The operation in the specified account and Region is currently in progress.

          • PENDING: The operation in the specified account and Region has yet to start.

          • SUCCEEDED: The operation in the specified account and Region completed successfully.

          Possible values include:
          • "PENDING"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
          • "CANCELLED"
        • StatusReason — (String)

          The reason for the assigned result status.

        • AccountGateResult — (map)

          The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account

          • Status — (String)

            The status of the account gate function.

            • SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

            • FAILED: The account gate function has determined that the account and Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.

            • SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

              • An account gate function has not been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region.

              • The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and Region.

              • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.

            Possible values include:
            • "SUCCEEDED"
            • "FAILED"
            • "SKIPPED"
          • StatusReason — (String)

            The reason for the account gate status assigned to this account and Region for the stack set operation.

        • OrganizationalUnitId — (String)

          [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

      • NextToken — (String)

        If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns summary information about operations performed on a stack set.

Service Reference:

Examples:

Calling the listStackSetOperations operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudformation.listStackSetOperations(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to get operation summaries for.

    • NextToken — (String)

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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 StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

        • OperationId — (String)

          The unique ID of the stack set operation.

        • Action — (String)

          The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.

          Possible values include:
          • "CREATE"
          • "UPDATE"
          • "DELETE"
          • "DETECT_DRIFT"
        • Status — (String)

          The overall status of the operation.

          • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

          • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

          • RUNNING: The operation is currently being performed.

          • STOPPED: The user has cancelled the operation.

          • STOPPING: The operation is in the process of stopping, at user request.

          • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

          Possible values include:
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
          • "STOPPING"
          • "STOPPED"
          • "QUEUED"
        • CreationTimestamp — (Date)

          The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

        • EndTimestamp — (Date)

          The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

      • NextToken — (String)

        If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns summary information about stack sets that are associated with the user.

  • [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.

  • [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.

  • [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.

Service Reference:

Examples:

Calling the listStackSets operation

var params = {
  CallAs: SELF | DELEGATED_ADMIN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: ACTIVE | DELETED
};
cloudformation.listStackSets(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)

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • Status — (String)

      The status of the stack sets that you want to get summary information about.

      Possible values include:
      • "ACTIVE"
      • "DELETED"
    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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 StackSetSummary structures that contain information about the user's stack sets.

        • StackSetName — (String)

          The name of the stack set.

        • StackSetId — (String)

          The ID of the stack set.

        • Description — (String)

          A description of the stack set that you specify when the stack set is created or updated.

        • Status — (String)

          The status of the stack set.

          Possible values include:
          • "ACTIVE"
          • "DELETED"
        • AutoDeployment — (map)

          [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).

          • Enabled — (Boolean)

            If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

          • RetainStacksOnAccountRemoval — (Boolean)

            If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

        • PermissionModel — (String)

          Describes how the IAM roles required for stack set operations are created.

          Possible values include:
          • "SERVICE_MANAGED"
          • "SELF_MANAGED"
        • DriftStatus — (String)

          Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

          • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

          • NOT_CHECKED: CloudFormation has not checked the stack set for drift.

          • IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

          • UNKNOWN: This value is reserved for future use.

          Possible values include:
          • "DRIFTED"
          • "IN_SYNC"
          • "UNKNOWN"
          • "NOT_CHECKED"
        • LastDriftCheckTimestamp — (Date)

          Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns a list of registration tokens for the specified extension(s).

Service Reference:

Examples:

Calling the listTypeRegistrations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegistrationStatusFilter: COMPLETE | IN_PROGRESS | FAILED,
  Type: RESOURCE | MODULE,
  TypeArn: 'STRING_VALUE',
  TypeName: 'STRING_VALUE'
};
cloudformation.listTypeRegistrations(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: {}) —
    • Type — (String)

      The kind of extension.

      Conditional: You must specify either TypeName and Type, or Arn.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • TypeArn — (String)

      The Amazon Resource Name (ARN) of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • RegistrationStatusFilter — (String)

      The current status of the extension registration request.

      The default is IN_PROGRESS.

      Possible values include:
      • "COMPLETE"
      • "IN_PROGRESS"
      • "FAILED"
    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • NextToken — (String)

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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:

      • RegistrationTokenList — (Array<String>)

        A list of extension registration tokens.

        Use DescribeTypeRegistration to return detailed information about a type registration request.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns summary information about extension that have been registered with CloudFormation.

Service Reference:

Examples:

Calling the listTypes operation

var params = {
  DeprecatedStatus: LIVE | DEPRECATED,
  Filters: {
    Category: REGISTERED | ACTIVATED | THIRD_PARTY | AWS_TYPES,
    PublisherId: 'STRING_VALUE',
    TypeNamePrefix: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProvisioningType: NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE,
  Type: RESOURCE | MODULE,
  Visibility: PUBLIC | PRIVATE
};
cloudformation.listTypes(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: {}) —
    • Visibility — (String)

      The scope at which the extensions are visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE: Extensions that are visible and usable within this account and region. This includes:

        • Private extensions you have registered in this account and region.

        • Public extensions that you have activated in this account and region.

      • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon account. This includes extensions from Amazon, as well as third-party publishers.

      The default is PRIVATE.

      Possible values include:
      • "PUBLIC"
      • "PRIVATE"
    • ProvisioningType — (String)

      For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

      Valid values include:

      • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

      • IMMUTABLE: The resource type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

      The default is FULLY_MUTABLE.

      Possible values include:
      • "NON_PROVISIONABLE"
      • "IMMUTABLE"
      • "FULLY_MUTABLE"
    • DeprecatedStatus — (String)

      The deprecation status of the extension that you want to get summary information about.

      Valid values include:

      • LIVE: The extension is registered for use in CloudFormation operations.

      • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

      Possible values include:
      • "LIVE"
      • "DEPRECATED"
    • Type — (String)

      The type of extension.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • Filters — (map)

      Filter criteria to use in determining which extensions to return.

      If you specify a filter, CloudFormation ignores any specified Visibility value when returning the list of types.

      • Category — (String)

        The category of extensions to return.

        • REGISTERED: Private extensions that have been registered for this account and region.

        • ACTIVATED: Public extensions that have been activated for this account and region.

        • THIRD-PARTY: Extensions available for use from publishers other than Amazon. This includes:

          • Private extensions registered in the account.

          • Public extensions from publishers other than Amazon, whether activated or not.

        • AWS-TYPES: Extensions available for use from Amazon.

        Possible values include:
        • "REGISTERED"
        • "ACTIVATED"
        • "THIRD_PARTY"
        • "AWS_TYPES"
      • PublisherId — (String)

        The id of the publisher of the extension.

        Extensions published by Amazon are not assigned a publisher ID. Use the AWS-TYPES category to specify a list of types published by Amazon.

      • TypeNamePrefix — (String)

        A prefix to use as a filter for results.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • NextToken — (String)

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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:

      • TypeSummaries — (Array<map>)

        A list of TypeSummary structures that contain information about the specified extensions.

        • Type — (String)

          The kind of extension.

          Possible values include:
          • "RESOURCE"
          • "MODULE"
        • TypeName — (String)

          The name of the extension.

          If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

        • DefaultVersionId — (String)

          The ID of the default version of the extension. The default version is used when the extension version is not specified.

          This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

          To set the default version of an extension, use SetTypeDefaultVersion .

        • TypeArn — (String)

          The Amazon Resource Name (ARN) of the extension.

        • LastUpdated — (Date)

          When the specified extension version was registered. This applies only to:

          • Private extensions you have registered in your account. For more information, see RegisterType.

          • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

          For all other extension types, CloudFormation returns null.

        • Description — (String)

          The description of the extension.

        • PublisherId — (String)

          The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

        • OriginalTypeName — (String)

          For public extensions that have been activated for this account and region, the type name of the public extension.

          If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

        • PublicVersionNumber — (String)

          For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.

          How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

        • LatestPublicVersion — (String)

          For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

          How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

        • PublisherIdentity — (String)

          The service used to verify the publisher identity.

          For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

          Possible values include:
          • "AWS_Marketplace"
          • "GitHub"
          • "Bitbucket"
        • PublisherName — (String)

          The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

        • IsActivated — (Boolean)

          Whether or not the extension is activated for this account and region.

          This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Returns summary information about the versions of an extension.

Service Reference:

Examples:

Calling the listTypeVersions operation

var params = {
  Arn: 'STRING_VALUE',
  DeprecatedStatus: LIVE | DEPRECATED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PublisherId: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE'
};
cloudformation.listTypeVersions(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: {}) —
    • Type — (String)

      The kind of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension for which you want version summary information.

      Conditional: You must specify either TypeName and Type, or Arn.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the extension for which you want version summary information.

      Conditional: You must specify either TypeName and Type, or Arn.

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • NextToken — (String)

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • DeprecatedStatus — (String)

      The deprecation status of the extension versions that you want to get summary information about.

      Valid values include:

      • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

      • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

      The default is LIVE.

      Possible values include:
      • "LIVE"
      • "DEPRECATED"
    • PublisherId — (String)

      The publisher ID of the extension publisher.

      Extensions published by Amazon are not assigned a publisher ID.

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:

      • TypeVersionSummaries — (Array<map>)

        A list of TypeVersionSummary structures that contain information about the specified extension's versions.

        • Type — (String)

          The kind of extension.

          Possible values include:
          • "RESOURCE"
          • "MODULE"
        • TypeName — (String)

          The name of the extension.

        • VersionId — (String)

          The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

        • IsDefaultVersion — (Boolean)

          Whether the specified extension version is set as the default version.

          This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns null.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the extension version.

        • TimeCreated — (Date)

          When the version was registered.

        • Description — (String)

          The description of the extension version.

        • PublicVersionNumber — (String)

          For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region. For any extensions other than activated third-arty extensions, CloudFormation returns null.

          How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

      • NextToken — (String)

        If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Returns:

  • (AWS.Request) —

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

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

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Service Reference:

Examples:

Calling the publishType operation

var params = {
  Arn: 'STRING_VALUE',
  PublicVersionNumber: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE'
};
cloudformation.publishType(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: {}) —
    • Type — (String)

      The type of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • Arn — (String)

      The Amazon Resource Number (ARN) of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

    • PublicVersionNumber — (String)

      The version number to assign to this version of the extension.

      Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

      MAJOR.MINOR.PATCH

      For more information, see Semantic Versioning 2.0.0.

      If you do not specify a version number, CloudFormation increments the version number by one minor version release.

      The first time you publish a type, CloudFormation sets the version number to 1.0.0, regardless of the value you specify.

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:

      • PublicTypeArn — (String)

        The Amazon Resource Number (ARN) assigned to the public extension upon publication.

Returns:

  • (AWS.Request) —

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

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

Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Do not use this API in your code.

Service Reference:

Examples:

Calling the recordHandlerProgress operation

var params = {
  BearerToken: 'STRING_VALUE', /* required */
  OperationStatus: PENDING | IN_PROGRESS | SUCCESS | FAILED, /* required */
  ClientRequestToken: 'STRING_VALUE',
  CurrentOperationStatus: PENDING | IN_PROGRESS | SUCCESS | FAILED,
  ErrorCode: NotUpdatable | InvalidRequest | AccessDenied | InvalidCredentials | AlreadyExists | NotFound | ResourceConflict | Throttling | ServiceLimitExceeded | NotStabilized | GeneralServiceException | ServiceInternalError | NetworkFailure | InternalFailure | InvalidTypeConfiguration,
  ResourceModel: 'STRING_VALUE',
  StatusMessage: 'STRING_VALUE'
};
cloudformation.recordHandlerProgress(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: {}) —
    • BearerToken — (String)

      Reserved for use by the CloudFormation CLI.

    • OperationStatus — (String)

      Reserved for use by the CloudFormation CLI.

      Possible values include:
      • "PENDING"
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"
    • CurrentOperationStatus — (String)

      Reserved for use by the CloudFormation CLI.

      Possible values include:
      • "PENDING"
      • "IN_PROGRESS"
      • "SUCCESS"
      • "FAILED"
    • StatusMessage — (String)

      Reserved for use by the CloudFormation CLI.

    • ErrorCode — (String)

      Reserved for use by the CloudFormation CLI.

      Possible values include:
      • "NotUpdatable"
      • "InvalidRequest"
      • "AccessDenied"
      • "InvalidCredentials"
      • "AlreadyExists"
      • "NotFound"
      • "ResourceConflict"
      • "Throttling"
      • "ServiceLimitExceeded"
      • "NotStabilized"
      • "GeneralServiceException"
      • "ServiceInternalError"
      • "NetworkFailure"
      • "InternalFailure"
      • "InvalidTypeConfiguration"
    • ResourceModel — (String)

      Reserved for use by the CloudFormation CLI.

    • ClientRequestToken — (String)

      Reserved for use by the CloudFormation CLI.

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.

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

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

Service Reference:

Examples:

Calling the registerPublisher operation

var params = {
  AcceptTermsAndConditions: true || false,
  ConnectionArn: 'STRING_VALUE'
};
cloudformation.registerPublisher(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: {}) —
    • AcceptTermsAndConditions — (Boolean)

      Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

      The default is false.

    • ConnectionArn — (String)

      If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

      For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

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:

      • PublisherId — (String)

        The ID assigned this account by CloudFormation for publishing extensions.

Returns:

  • (AWS.Request) —

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

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

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

  • Validating the extension schema

  • Determining which handlers, if any, have been specified for the extension

  • Making the extension available for use in your account

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Service Reference:

Examples:

Calling the registerType operation

var params = {
  SchemaHandlerPackage: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  ExecutionRoleArn: 'STRING_VALUE',
  LoggingConfig: {
    LogGroupName: 'STRING_VALUE', /* required */
    LogRoleArn: 'STRING_VALUE' /* required */
  },
  Type: RESOURCE | MODULE
};
cloudformation.registerType(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: {}) —
    • Type — (String)

      The kind of extension.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension being registered.

      We recommend that extension names adhere to the following patterns:

      • For resource types, company_or_organization::service::type.

      • For modules, company_or_organization::service::type::MODULE.

      Note: The following organization namespaces are reserved and cannot be used in your extension names:
      • Alexa
      • AMZN
      • Amazon
      • AWS
      • Custom
      • Dev
    • SchemaHandlerPackage — (String)

      A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

      For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

      Note: The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
    • LoggingConfig — (map)

      Specifies logging configuration information for an extension.

      • LogRoleArn — required — (String)

        The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

      • LogGroupName — required — (String)

        The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the extension's handlers.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

      For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

      If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

    • ClientRequestToken — (String)

      A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

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:

      • RegistrationToken — (String)

        The identifier for this registration request.

        Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.

Returns:

  • (AWS.Request) —

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

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

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks API.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE

  • UPDATE_COMPLETE

  • UPDATE_ROLLBACK_COMPLETE

  • IMPORT_COMPLETE

  • IMPORT_ROLLBACK_COMPLETE

Service Reference:

Examples:

Calling the rollbackStack operation

var params = {
  StackName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  RoleARN: 'STRING_VALUE'
};
cloudformation.rollbackStack(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.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

    • ClientRequestToken — (String)

      A unique identifier for this RollbackStack request.

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.

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 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.

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

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

It is strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.

Service Reference:

Examples:

Calling the setTypeConfiguration operation

var params = {
  Configuration: 'STRING_VALUE', /* required */
  ConfigurationAlias: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeArn: 'STRING_VALUE',
  TypeName: 'STRING_VALUE'
};
cloudformation.setTypeConfiguration(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: {}) —
    • TypeArn — (String)

      The Amazon Resource Name (ARN) for the extension, in this account and region.

      For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

      Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

    • Configuration — (String)

      The configuration data for the extension, in this account and region.

      The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

    • ConfigurationAlias — (String)

      An alias by which to refer to this extension configuration data.

      Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

    • Type — (String)

      The type of extension.

      Conditional: You must specify ConfigurationArn, or Type and TypeName.

      Possible values include:
      • "RESOURCE"
      • "MODULE"

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:

      • ConfigurationArn — (String)

        The Amazon Resource Name (ARN) for the configuration data, in this account and region.

        Conditional: You must specify ConfigurationArn, or Type and TypeName.

Returns:

  • (AWS.Request) —

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

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

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

Service Reference:

Examples:

Calling the setTypeDefaultVersion operation

var params = {
  Arn: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
cloudformation.setTypeDefaultVersion(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: {}) —
    • Arn — (String)

      The Amazon Resource Name (ARN) of the extension for which you want version summary information.

      Conditional: You must specify either TypeName and Type, or Arn.

    • Type — (String)

      The kind of extension.

      Conditional: You must specify either TypeName and Type, or Arn.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension.

      Conditional: You must specify either TypeName and Type, or Arn.

    • VersionId — (String)

      The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

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. 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 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.

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

Stops an in-progress operation on a stack set and its associated stack instances.

Service Reference:

Examples:

Calling the stopStackSetOperation operation

var params = {
  OperationId: 'STRING_VALUE', /* required */
  StackSetName: 'STRING_VALUE', /* required */
  CallAs: SELF | DELEGATED_ADMIN
};
cloudformation.stopStackSetOperation(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to stop the operation for.

    • OperationId — (String)

      The ID of the stack operation.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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.

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

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

  • For resource types, this includes passing all contracts tests defined for the type.

  • For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.

If you do not specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.

Once you've initiated testing on an extension using TestType, you can use DescribeType to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

Service Reference:

Examples:

Calling the testType operation

var params = {
  Arn: 'STRING_VALUE',
  LogDeliveryBucket: 'STRING_VALUE',
  Type: RESOURCE | MODULE,
  TypeName: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
cloudformation.testType(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: {}) —
    • Arn — (String)

      The Amazon Resource Number (ARN) of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

    • Type — (String)

      The type of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

      Possible values include:
      • "RESOURCE"
      • "MODULE"
    • TypeName — (String)

      The name of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

    • VersionId — (String)

      The version of the extension to test.

      You can specify the version id with either Arn, or with TypeName and Type.

      If you do not specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

    • LogDeliveryBucket — (String)

      The S3 bucket to which CloudFormation delivers the contract test execution logs.

      CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

      The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

      • GetObject

      • PutObject

      For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

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:

      • TypeVersionArn — (String)

        The Amazon Resource Number (ARN) of the extension.

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 | CAPABILITY_AUTO_EXPAND,
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  DisableRollback: true || false,
  NotificationARNs: [
    'STRING_VALUE',
    /* more items */
  ],
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  RoleARN: 'STRING_VALUE',
  RollbackConfiguration: {
    MonitoringTimeInMinutes: 'NUMBER_VALUE',
    RollbackTriggers: [
      {
        Arn: 'STRING_VALUE', /* required */
        Type: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  StackPolicyBody: 'STRING_VALUE',
  StackPolicyDuringUpdateBody: 'STRING_VALUE',
  StackPolicyDuringUpdateURL: 'STRING_VALUE',
  StackPolicyURL: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* 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 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 or a Systems Manager document. For more information, go to Template Anatomy in the 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, CloudFormation uses the default value that is specified in your template.

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • Capabilities — (Array<String>)

      In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

      • CAPABILITY_AUTO_EXPAND

        Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

        If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

        You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

        Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

        For more information, see Using CloudFormation Macros to Perform Custom Processing on 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

    • RoleARN — (String)

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

    • RollbackConfiguration — (map)

      The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

      • RollbackTriggers — (Array<map>)

        The triggers to monitor during stack creation or update actions.

        By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

        • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

        • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

        • To remove all currently specified triggers, specify an empty list for this parameter.

        If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the rollback trigger.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Type — required — (String)

          The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

      • MonitoringTimeInMinutes — (Integer)

        The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

        The default is 0 minutes.

        If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

        If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

    • 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 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. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

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

      • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

      • Value — required — (String)

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

    • DisableRollback — (Boolean)

      Preserve the state of previously provisioned resources when an operation fails.

      Default: False

    • ClientRequestToken — (String)

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

      All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. 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.

      In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

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.

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

Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.

During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Service Reference:

Examples:

Calling the updateStackInstances operation

var params = {
  Regions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  StackSetName: 'STRING_VALUE', /* required */
  Accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  CallAs: SELF | DELEGATED_ADMIN,
  DeploymentTargets: {
    Accounts: [
      'STRING_VALUE',
      /* more items */
    ],
    AccountsUrl: 'STRING_VALUE',
    OrganizationalUnitIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ParameterOverrides: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ]
};
cloudformation.updateStackInstances(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set associated with the stack instances.

    • Accounts — (Array<String>)

      [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

      You can specify Accounts or DeploymentTargets, but not both.

    • DeploymentTargets — (map)

      [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

      You can specify Accounts or DeploymentTargets, but not both.

      • Accounts — (Array<String>)

        The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

      • AccountsUrl — (String)

        Returns the value of the AccountsUrl property.

      • OrganizationalUnitIds — (Array<String>)

        The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    • Regions — (Array<String>)

      The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

    • ParameterOverrides — (Array<map>)

      A list of input parameters whose values you want to update for the specified stack instances.

      Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

      • To override the current value for a parameter, include the parameter and specify its value.

      • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

      • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

      • To leave all parameters set to their present values, do not specify this property at all.

      During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

      • ParameterKey — (String)

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

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • OperationPreferences — (map)

      Preferences for how CloudFormation performs this stack set operation.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • OperationId — (String)

      The unique identifier for this stack set operation.

      The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

      If you don't specify an operation ID, the SDK generates one automatically.

      If a token is not provided, the SDK will use a version 4 UUID.
    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The unique identifier for this stack set operation.

Returns:

  • (AWS.Request) —

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

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

Updates the stack set, and associated stack instances in the specified accounts and Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

Service Reference:

Examples:

Calling the updateStackSet operation

var params = {
  StackSetName: 'STRING_VALUE', /* required */
  Accounts: [
    'STRING_VALUE',
    /* more items */
  ],
  AdministrationRoleARN: 'STRING_VALUE',
  AutoDeployment: {
    Enabled: true || false,
    RetainStacksOnAccountRemoval: true || false
  },
  CallAs: SELF | DELEGATED_ADMIN,
  Capabilities: [
    CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND,
    /* more items */
  ],
  DeploymentTargets: {
    Accounts: [
      'STRING_VALUE',
      /* more items */
    ],
    AccountsUrl: 'STRING_VALUE',
    OrganizationalUnitIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Description: 'STRING_VALUE',
  ExecutionRoleName: 'STRING_VALUE',
  OperationId: 'STRING_VALUE',
  OperationPreferences: {
    FailureToleranceCount: 'NUMBER_VALUE',
    FailureTolerancePercentage: 'NUMBER_VALUE',
    MaxConcurrentCount: 'NUMBER_VALUE',
    MaxConcurrentPercentage: 'NUMBER_VALUE',
    RegionConcurrencyType: SEQUENTIAL | PARALLEL,
    RegionOrder: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Parameters: [
    {
      ParameterKey: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      ResolvedValue: 'STRING_VALUE',
      UsePreviousValue: true || false
    },
    /* more items */
  ],
  PermissionModel: SERVICE_MANAGED | SELF_MANAGED,
  Regions: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateURL: 'STRING_VALUE',
  UsePreviousTemplate: true || false
};
cloudformation.updateStackSet(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: {}) —
    • StackSetName — (String)

      The name or unique ID of the stack set that you want to update.

    • Description — (String)

      A brief description of updates that you are making.

    • TemplateBody — (String)

      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

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

    • TemplateURL — (String)

      The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

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

    • UsePreviousTemplate — (Boolean)

      Use the existing template that's associated with the stack set that you're updating.

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

    • Parameters — (Array<map>)

      A list of input parameters for the stack set template.

      • ParameterKey — (String)

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

      • ParameterValue — (String)

        The input 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.

      • ResolvedValue — (String)

        Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

    • Capabilities — (Array<String>)

      In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.

      • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

        Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.

        The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

        • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

        If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

      • CAPABILITY_AUTO_EXPAND

        Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

        Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
    • Tags — (Array<map>)

      The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

      If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

      • If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.

      • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

      • If you specify an empty value, CloudFormation removes all currently associated tags.

      If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

      • Key — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

      • Value — required — (String)

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

    • OperationPreferences — (map)

      Preferences for how CloudFormation performs this stack set operation.

      • RegionConcurrencyType — (String)

        The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

        Possible values include:
        • "SEQUENTIAL"
        • "PARALLEL"
      • RegionOrder — (Array<String>)

        The order of the Regions in where you want to perform the stack operation.

      • FailureToleranceCount — (Integer)

        The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

        By default, 0 is specified.

      • FailureTolerancePercentage — (Integer)

        The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

        Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

        By default, 0 is specified.

      • MaxConcurrentCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

      • MaxConcurrentPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

        By default, 1 is specified.

    • AdministrationRoleARN — (String)

      The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

      Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

      If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

    • ExecutionRoleName — (String)

      The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

      Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

      If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

    • DeploymentTargets — (map)

      [Service-managed permissions] The Organizations accounts in which to update associated stack instances.

      To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

      If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

      • Accounts — (Array<String>)

        The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

      • AccountsUrl — (String)

        Returns the value of the AccountsUrl property.

      • OrganizationalUnitIds — (Array<String>)

        The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    • PermissionModel — (String)

      Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

      Possible values include:
      • "SERVICE_MANAGED"
      • "SELF_MANAGED"
    • AutoDeployment — (map)

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

      If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

      • Enabled — (Boolean)

        If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

      • RetainStacksOnAccountRemoval — (Boolean)

        If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

    • OperationId — (String)

      The unique ID for this stack set operation.

      The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

      If you don't specify an operation ID, CloudFormation generates one automatically.

      Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Accounts — (Array<String>)

      [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

      To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

      If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    • Regions — (Array<String>)

      The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

      To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

      If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    • CallAs — (String)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Possible values include:
      • "SELF"
      • "DELEGATED_ADMIN"

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:

      • OperationId — (String)

        The unique ID for this stack set operation.

Returns:

  • (AWS.Request) —

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

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

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

Service Reference:

Examples:

Calling the updateTerminationProtection operation

var params = {
  EnableTerminationProtection: true || false, /* required */
  StackName: 'STRING_VALUE' /* required */
};
cloudformation.updateTerminationProtection(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: {}) —
    • EnableTerminationProtection — (Boolean)

      Whether to enable termination protection on the specified stack.

    • StackName — (String)

      The name or unique ID of the stack for which you want to set termination protection.

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)

        The unique ID 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. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, 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 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 or a Systems Manager document. For more information, go to Template Anatomy in the 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 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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('stackImportComplete', params = {}, [callback]) ⇒ AWS.Request

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

Examples:

Waiting for the stackImportComplete state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackImportComplete', 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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('stackRollbackComplete', params = {}, [callback]) ⇒ AWS.Request

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

Examples:

Waiting for the stackRollbackComplete state

var params = {
  // ... input parameters ...
};
cloudformation.waitFor('stackRollbackComplete', 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.

        • StackName — required — (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, CloudFormation uses the default value that is specified in your template.

          • ParameterValue — (String)

            The input 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.

          • ResolvedValue — (String)

            Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

        • CreationTime — required — (Date)

          The time at which the stack was created.

        • DeletionTime — (Date)

          The time the stack was deleted.

        • LastUpdatedTime — (Date)

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

        • RollbackConfiguration — (map)

          The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

          • RollbackTriggers — (Array<map>)

            The triggers to monitor during stack creation or update actions.

            By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

            • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

            • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

            • To remove all currently specified triggers, specify an empty list for this parameter.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the rollback trigger.

              If a specified trigger is missing, the entire stack operation fails and is rolled back.

            • Type — required — (String)

              The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

          • MonitoringTimeInMinutes — (Integer)

            The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

            The default is 0 minutes.

            If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

            If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

        • StackStatus — required — (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_FAILED"
          • "UPDATE_ROLLBACK_IN_PROGRESS"
          • "UPDATE_ROLLBACK_FAILED"
          • "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
          • "UPDATE_ROLLBACK_COMPLETE"
          • "REVIEW_IN_PROGRESS"
          • "IMPORT_IN_PROGRESS"
          • "IMPORT_COMPLETE"
          • "IMPORT_ROLLBACK_IN_PROGRESS"
          • "IMPORT_ROLLBACK_FAILED"
          • "IMPORT_ROLLBACK_COMPLETE"
        • 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.

          • ExportName — (String)

            The name of the export associated with the output.

        • RoleARN — (String)

          The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

          • Value — required — (String)

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

        • EnableTerminationProtection — (Boolean)

          Whether termination protection is enabled for the stack.

          For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

        • ParentId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • RootId — (String)

          For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

          For more information, see Working with Nested Stacks in the CloudFormation User Guide.

        • DriftInformation — (map)

          Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • StackDriftStatus — required — (String)

            Status of the stack's actual configuration compared to its expected template configuration.

            • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

            • NOT_CHECKED: CloudFormation has not checked if the stack differs from its expected template configuration.

            • IN_SYNC: The stack's actual configuration matches its expected template configuration.

            • UNKNOWN: This value is reserved for future use.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
            • "UNKNOWN"
            • "NOT_CHECKED"
          • LastCheckTimestamp — (Date)

            Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

      • 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, CloudFormation uses the default value that is specified in your template.

        • ParameterValue — (String)

          The input 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.

        • ResolvedValue — (String)

          Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

      • 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 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_PENDING"
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
        • "FAILED"
      • StatusReason — (String)

        A description of the change set's status. For example, if your attempt to create a change set failed, 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.

      • RollbackConfiguration — (map)

        The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

        • RollbackTriggers — (Array<map>)

          The triggers to monitor during stack creation or update actions.

          By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

          • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

          • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

          • To remove all currently specified triggers, specify an empty list for this parameter.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the rollback trigger.

            If a specified trigger is missing, the entire stack operation fails and is rolled back.

          • Type — required — (String)

            The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

        • MonitoringTimeInMinutes — (Integer)

          The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

          The default is 0 minutes.

          If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

          If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

      • 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 — required — (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 (Amazon Web Services) have the reserved prefix: aws:.

        • Value — required — (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 CloudFormation changes if you execute the change set.

        • Type — (String)

          The type of entity that 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 CloudFormation will perform.

          • Action — (String)

            The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource cannot be determined).

            Possible values include:
            • "Add"
            • "Modify"
            • "Remove"
            • "Import"
            • "Dynamic"
          • 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 CloudFormation resource, such as AWS::S3::Bucket.

          • Replacement — (String)

            For the Modify action, indicates whether 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 CloudFormation will make to the resource.

            • Target — (map)

              A ResourceTargetDefinition structure that describes the field that 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 CloudFormation User Guide.

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

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

              For Static evaluations, 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, 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, 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 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.

          • ChangeSetId — (String)

            The change set ID of the nested change set.

          • ModuleInfo — (map)

            Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

            • TypeHierarchy — (String)

              A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

              In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that is nested inside a parent module of type AWS::Second::Example::MODULE.

              AWS::First::Example::MODULE/AWS::Second::Example::MODULE

            • LogicalIdHierarchy — (String)

              A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

              In the following example, the resource was created from a module, moduleA, that is nested inside a parent module, moduleB.

              moduleA/moduleB

              For more information, see Referencing resources in a module in the CloudFormation User Guide.

      • 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.

      • IncludeNestedStacks — (Boolean)

        Verifies if IncludeNestedStacks is set to True.

      • ParentChangeSetId — (String)

        Specifies the change set ID of the parent change set in the current nested change set hierarchy.

      • RootChangeSetId — (String)

        Specifies the change set ID of the root change set in the current nested change set hierarchy.

Returns:

  • (AWS.Request) —

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

See Also:

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

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

Examples:

Waiting for the typeRegistrationComplete state

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

Parameters:

  • params (Object) —
    • RegistrationToken — (String)

      The identifier for this registration request.

      This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

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:

      • ProgressStatus — (String)

        The current status of the extension registration request.

        Possible values include:
        • "COMPLETE"
        • "IN_PROGRESS"
        • "FAILED"
      • Description — (String)

        The description of the extension registration request.

      • TypeArn — (String)

        The Amazon Resource Name (ARN) of the extension being registered.

        For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

      • TypeVersionArn — (String)

        The Amazon Resource Name (ARN) of this specific version of the extension being registered.

        For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

Returns:

  • (AWS.Request) —

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

See Also: