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

Inherits:
AWS.Service show all
Identifier:
cloudcontrol
API Version:
2021-09-30
Defined in:
(unknown)

Overview

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

Service Description

Use Amazon Web Services Cloud Control API to create, read, update, delete, and list (CRUD-L) your cloud resources that belong to a wide range of services--both Amazon Web Services and third-party. With the Cloud Control API standardized set of application programming interfaces (APIs), you can perform CRUD-L operations on any supported resources in your Amazon Web Services account. Using Cloud Control API, you won't have to generate code or scripts specific to each individual service responsible for those resources.

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.

Sending a Request Using CloudControl

var cloudcontrol = new AWS.CloudControl();
cloudcontrol.cancelResourceRequest(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 CloudControl object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudcontrol = new AWS.CloudControl({apiVersion: '2021-09-30'});

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

AWS.config.apiVersions = {
  cloudcontrol: '2021-09-30',
  // other service API versions
};

var cloudcontrol = new AWS.CloudControl();

Version:

  • 2021-09-30

Waiter Resource States

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

resourceRequestSuccess

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.CloudControl(options = {}) ⇒ Object

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

Examples:

Constructing a CloudControl object

var cloudcontrol = new AWS.CloudControl({apiVersion: '2021-09-30'});

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.CloudControl.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CloudControl.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'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be cancelled.

Service Reference:

Examples:

Calling the cancelResourceRequest operation

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

      The RequestToken of the ProgressEvent object returned by the resource operation 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:

      • ProgressEvent — (map)

        Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

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

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource.

Service Reference:

Examples:

Calling the createResource operation

var params = {
  DesiredState: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TypeVersionId: 'STRING_VALUE'
};
cloudcontrol.createResource(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 name of the resource type.

    • TypeVersionId — (String)

      For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

      If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

      For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    • ClientToken — (String)

      A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

      A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

      If you do not specify a client token, one is generated for inclusion in the request.

      For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

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

      Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

      Note: Cloud Control API currently supports JSON as a structured data format.

      Specify the desired state as one of the following:

      • A JSON blob

      • A local path containing the desired state in JSON data format

      For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

      For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the Amazon Web Services CloudFormation Users 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:

      • ProgressEvent — (map)

        Represents the current status of the resource creation request.

        After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by CreateResource.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

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

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

Service Reference:

Examples:

Calling the deleteResource operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TypeVersionId: 'STRING_VALUE'
};
cloudcontrol.deleteResource(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 name of the resource type.

    • TypeVersionId — (String)

      For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

      If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

      For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    • ClientToken — (String)

      A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

      A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

      If you do not specify a client token, one is generated for inclusion in the request.

      For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

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

      The identifier for the resource.

      You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

      For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

      For more information, see Identifying resources in the Amazon Web Services Cloud Control API 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:

      • ProgressEvent — (map)

        Represents the current status of the resource deletion request.

        After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

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

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Service Reference:

Examples:

Calling the getResource operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE',
  TypeVersionId: 'STRING_VALUE'
};
cloudcontrol.getResource(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 name of the resource type.

    • TypeVersionId — (String)

      For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

      If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

      For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    • Identifier — (String)

      The identifier for the resource.

      You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

      For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

      For more information, see Identifying resources in the Amazon Web Services Cloud Control API 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:

      • TypeName — (String)

        The name of the resource type.

      • ResourceDescription — (map)

        Represents information about a provisioned resource.

        • Identifier — (String)

          The primary identifier for the resource.

          For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

        • Properties — (String)

          A list of the resource properties and their current values.

Returns:

  • (AWS.Request)

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

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

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Service Reference:

Examples:

Calling the getResourceRequestStatus operation

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

      A unique token used to track the progress of the resource operation request.

      Request tokens are included in the ProgressEvent type returned by a resource operation 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:

      • ProgressEvent — (map)

        Represents the current status of the resource operation request.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Note: Resource operation requests expire after seven days.

Service Reference:

Examples:

Calling the listResourceRequests operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceRequestStatusFilter: {
    OperationStatuses: [
      PENDING | IN_PROGRESS | SUCCESS | FAILED | CANCEL_IN_PROGRESS | CANCEL_COMPLETE,
      /* more items */
    ],
    Operations: [
      CREATE | DELETE | UPDATE,
      /* more items */
    ]
  }
};
cloudcontrol.listResourceRequests(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: {})
    • 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.

      The default is 20.

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

    • ResourceRequestStatusFilter — (map)

      The filter criteria to apply to the requests returned.

      • Operations — (Array<String>)

        The operation types to include in the filter.

      • OperationStatuses — (Array<String>)

        The operation statuses to include in the filter.

        • PENDING: The operation has been requested, but not yet initiated.

        • IN_PROGRESS: The operation is currently in progress.

        • SUCCESS: The operation has successfully completed.

        • FAILED: The operation has failed.

        • CANCEL_IN_PROGRESS: The operation is currently in the process of being canceled.

        • CANCEL_COMPLETE: The operation has been canceled.

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:

      • ResourceRequestStatusSummaries — (Array<map>)

        The requests that match the specified filter criteria.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation 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 ListResources 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.

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

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Service Reference:

Examples:

Calling the listResources operation

var params = {
  TypeName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceModel: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TypeVersionId: 'STRING_VALUE'
};
cloudcontrol.listResources(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 name of the resource type.

    • TypeVersionId — (String)

      For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

      If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

      For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

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

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

      The default is 20.

    • ResourceModel — (String)

      The resource model to use to select the resources to return.

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:

      • TypeName — (String)

        The name of the resource type.

      • ResourceDescriptions — (Array<map>)

        Information about the specified resources, including primary identifier and resource model.

        • Identifier — (String)

          The primary identifier for the resource.

          For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

        • Properties — (String)

          A list of the resource properties and their current values.

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

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

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.

For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the Amazon Web Services CloudFormation Users Guide.

Service Reference:

Examples:

Calling the updateResource operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  PatchDocument: 'STRING_VALUE', /* required */
  TypeName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TypeVersionId: 'STRING_VALUE'
};
cloudcontrol.updateResource(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 name of the resource type.

    • TypeVersionId — (String)

      For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

      If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

      For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    • ClientToken — (String)

      A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

      A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

      If you do not specify a client token, one is generated for inclusion in the request.

      For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

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

      The identifier for the resource.

      You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

      For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

      For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

    • PatchDocument — (String)

      A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the Amazon Web Services Cloud Control API 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:

      • ProgressEvent — (map)

        Represents the current status of the resource update request.

        Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

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

Waits for a given CloudControl 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 resourceRequestSuccess state

var params = {
  RequestToken: 'STRING_VALUE' /* required */
};
cloudcontrol.waitFor('resourceRequestSuccess', 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

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

Waits for the resourceRequestSuccess state by periodically calling the underlying CloudControl.getResourceRequestStatus() operation every 5 seconds (at most 720 times).

Examples:

Waiting for the resourceRequestSuccess state

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

Parameters:

  • params (Object)
    • RequestToken — (String)

      A unique token used to track the progress of the resource operation request.

      Request tokens are included in the ProgressEvent type returned by a resource operation 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:

      • ProgressEvent — (map)

        Represents the current status of the resource operation request.

        • TypeName — (String)

          The name of the resource type used in the operation.

        • Identifier — (String)

          The primary identifier for the resource.

          Note: In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.
        • RequestToken — (String)

          The unique token representing this resource operation request.

          Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

        • Operation — (String)

          The resource operation type.

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

          The current status of the resource operation request.

          • PENDING: The resource operation has not yet started.

          • IN_PROGRESS: The resource operation is currently in progress.

          • SUCCESS: The resource operation has successfully completed.

          • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

          • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

          • CANCEL_COMPLETE: The resource operation has been canceled.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAILED"
          • "CANCEL_IN_PROGRESS"
          • "CANCEL_COMPLETE"
        • EventTime — (Date)

          When the resource operation request was initiated.

        • ResourceModel — (String)

          A JSON string containing the resource model, consisting of each resource property and its current value.

        • StatusMessage — (String)

          Any message explaining the current status.

        • ErrorCode — (String)

          For requests with a status of FAILED, the associated error code.

          For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

          Possible values include:
          • "NotUpdatable"
          • "InvalidRequest"
          • "AccessDenied"
          • "InvalidCredentials"
          • "AlreadyExists"
          • "NotFound"
          • "ResourceConflict"
          • "Throttling"
          • "ServiceLimitExceeded"
          • "NotStabilized"
          • "GeneralServiceException"
          • "ServiceInternalError"
          • "ServiceTimeout"
          • "NetworkFailure"
          • "InternalFailure"
        • RetryAfter — (Date)

          When to next request the status of this resource operation request.

Returns:

  • (AWS.Request)

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

See Also: