Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Custom Resource Response Objects

Custom Resource Provider Response Fields

Status

The status value sent by the custom resource provider in response to an AWS CloudFormation-generated request.

Must be either SUCCESS or FAILED.

Required: Yes

Type: String

Reason

Describes the reason for a failure response.

Required: Required if Status is FAILED; optional otherwise.

Type: String

PhysicalResourceId

This value should be an identifier unique to the custom resource vendor, and can be up to 1Kb in size. The value must be a non-empty string.

Required: Yes

Type: String

StackId

The Amazon Resource Name (ARN) that identifies the stack containing the custom resource. This response value should be copied verbatim from the request.

Required: Yes

Type: String

RequestId

A unique ID for the request. This response value should be copied verbatim from the request.

Required: Yes

Type: String

LogicalResourceId

The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request.

Required: Yes

Type: String

Data

Optional, custom resource provider-defined name-value pairs to send with the response. The values provided here can be accessed by name in the template with Fn::GetAtt.

Required: No

Type: JSON object