ProgressEvent object schema - Extension Development for CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ProgressEvent object schema

A ProgressEvent is a JSON object which represents the current operation status of the handler, the current live state of the resource, and any additional resource information the handler wishes to communicate to the CloudFormation CLI. Each handler MUST communicate a progress event to the CloudFormation CLI under certain circumstances, and SHOULD communicate a progress event under others. For more information, see Handler Communication Contract.

A handler MAY use progress events on a re-invocation to continue work from where it left off. For a detailed discussion of this, see Progress chaining, stabilization and callback pattern.

Syntax

Below is the syntax for the ProgressEvent object.

{
    "OperationStatus": "string",
    "HandlerErrorCode": "string",
    "Message": "string",
    "CallbackContext": "string",
    "CallbackDelaySeconds": "string",
    "ResourceModel": "string",
    "ResourceModels": [
        "string"
    ],
    "NextToken": "string",
    }

Properties

OperationStatus

Indicates whether the handler has reached a terminal state or is still computing and requires more time to complete.

Values: PENDING | IN_PROGRESS | SUCCESS | FAILED

Required: No

HandlerErrorCode

A handler error code should be provided when the event operation status is FAILED or IN_PROGRESS.

For a list of handler error codes, see Handler Error Codes.

Required: Conditional. A handler error codes MUST be returned from the handler whenever there is a progress event with an operation status of FAILED.

Message

Information which can be shown to users to indicate the nature of a progress transition or callback delay.

Required: No

CallbackContext

Arbitrary information which the handler can return in an event with operation status of IN_PROGRESS, to allow the passing through of additional state or metadata between subsequent retries. For example, to pass through a resource identifier which can be used to continue polling for stabilization.

For more detailed examples, see Progress chaining, stabilization and callback pattern.

Required: No

CallbackDelaySeconds

A callback will be scheduled with an initial delay of no less than the number of seconds specified.

Set this value to less than 0 to indicate no callback should be made.

Required: No

ResourceModel

Resource model returned by a read or list operation response for synchronous results, or for final response validation/confirmation by create, update, and delete operations.

Required: No

ResourceModels

List of resource models returned by a list operation response for synchronous results.

Required: Conditional. Required for List handlers.

NextToken

Token used to request additional pages of resources from a list operation response.

Required: Conditional. Required for List handlers.