| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
Create
Custom resource provider requests with RequestType set to "Create" are sent
when the template developer creates a stack that contains a custom resource.
Request
Create requests contain the following fields:
- RequestType
Will be "Create".
- RequestId
A unique ID for the request.
- ResponseURL
The response URL identifies a pre-signed Amazon S3 bucket that receives responses from the custom resource provider to AWS CloudFormation.
- LogicalResourceId
The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template.
- StackId
The Amazon Resource Name (ARN) that identifies the stack containing the custom resource.
- ResourceProperties
This field contains the contents of the Properties object sent by the template developer. Its contents are defined by the custom resource provider.
Example
{
"RequestType" : "Create",
"RequestId" : "unique id for this create request",
"ResponseURL" : "pre-signed-url-for-create-response",
"LogicalResourceId" : "name of resource in template",
"StackId" : "arn:aws:cloudformation:us-east-1:namespace:stack/stack-name/guid",
"ResourceProperties" : {
"key1" : "string",
"key2" : [ "list" ],
"key3" : { "key4" : "map" }
}
} Responses
Success
When the create request is successful, a response must be sent to the S3 bucket with the following fields:
- Status
Must be "SUCCESS".
- 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.
- RequestId
A unique ID for the request. This response value should be copied verbatim from the request.
- StackId
The Amazon Resource Name (ARN) that identifies the stack containing the custom resource. This response value should be copied verbatim from the request.
- PhysicalResourceId
This value should be an identifier unique to the custom resource vendor, and can be up to 1Kb in size.
- 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.
Example
{
"Status" : "SUCCESS",
"LogicalResourceId" : "name of resource in template (copied from request)",
"RequestId" : "unique id for this create request (copied from request)",
"StackId" : "arn:aws:cloudformation:us-east-1:namespace:stack/stack-name/guid (copied from request)",
"PhysicalResourceId" : "required vendor-defined physical id that is unique for that vendor",
"Data" : {
"keyThatCanBeUsedInGetAtt1" : "data for key 1",
"keyThatCanBeUsedInGetAtt2" : "data for key 2"
}
} Failed
When the create request fails, a response must be sent to the S3 bucket with the following fields:
- Status
Must be "FAILED".
- Reason
Describes the reason for a failure response.
- 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.
- RequestId
A unique ID for the request. This response value should be copied verbatim from the request.
- StackId
The Amazon Resource Name (ARN) that identifies the stack containing the custom resource. This response value should be copied verbatim from the request.
Example
{
"Status" : "FAILED",
"Reason" : "Required failure reason string",
"LogicalResourceId" : "name of resource in template (copied from request)",
"RequestId" : "unique id for this create request (copied from request)",
"StackId" : "arn:aws:cloudformation:us-east-1:namespace:stack/stack-name/guid (copied from request)"
} 
