Class: AWS.CloudControl

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) role 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 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 hasn't 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.

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) role 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 hasn't 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.

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

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 hasn't 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:

• resourceRequestSuccess

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

      • SUCCESS: The operation completed.

      • FAILED: The operation failed.

      • CANCEL_IN_PROGRESS: The operation is 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 hasn't 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.

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

    Reserved.

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

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) role 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 hasn't 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.

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:

• resourceRequestSuccess