Delete
当 template developer 删除包含自定义资源的堆栈时,将发送 RequestType 设置为 Delete 的自定义资源提供程序请求。要成功删除带自定义资源的堆栈,custom resource provider 必须成功响应删除请求。
请求
删除请求包含以下字段:
- RequestType
-
Delete。 - RequestId
-
请求的唯一 ID。
- ResponseURL
-
响应 URL 标识预签名的 S3 存储桶,该存储桶接收 custom resource provider 到 Amazon CloudFormation 的响应。
- ResourceType
-
Amazon CloudFormation 模板中模板开发人员选择的自定义资源的资源类型。自定义资源类型名称的长度最多为 60 个字符,并且可包含字母数字字符和以下字符:
_@-。 - LogicalResourceId
-
Amazon CloudFormation 模板中 template developer 选择的自定义资源名称(逻辑 ID)。
- StackId
-
标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。
- PhysicalResourceId
-
custom resource provider 定义的必需物理 ID,该 ID 对于该提供程序是唯一的。
- ResourceProperties
-
该字段包含 template developer 发送的
Properties对象的内容。其内容由 custom resource provider 定义。
示例
{
"RequestType" : "Delete",
"RequestId" : "unique id for this delete request",
"ResponseURL" : "pre-signed-url-for-delete-response",
"ResourceType" : "Custom::MyCustomResourceType",
"LogicalResourceId" : "name of resource in template",
"StackId" : "arn:aws:cloudformation:us-east-2:namespace:stack/stack-name/guid",
"PhysicalResourceId" : "custom resource provider-defined physical id",
"ResourceProperties" : {
"key1" : "string",
"key2" : [ "list" ],
"key3" : { "key4" : "map" }
}
}
响应
成功
删除请求成功时,必须向 S3 存储桶发送包含以下字段的响应:
- Status
-
必须是
SUCCESS。 - RequestId
-
请求的唯一 ID。 此响应值应从请求中复制 verbatim。
- LogicalResourceId
-
Amazon CloudFormation 模板中 template developer 选择的自定义资源名称(逻辑 ID)。 此响应值应从请求中复制 verbatim。
- StackId
-
标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。 此响应值应从请求中复制 verbatim。
- PhysicalResourceId
-
该值应是对于自定义资源供应商具有唯一性的标识符,最大大小为 1 KB。该值必须是非空字符串,并且在所有响应中对于相同资源必须相同。
示例
{
"Status" : "SUCCESS",
"RequestId" : "unique id for this delete request (copied from request)",
"LogicalResourceId" : "name of resource in template (copied from request)",
"StackId" : "arn:aws:cloudformation:us-east-2:namespace:stack/stack-name/guid (copied from request)",
"PhysicalResourceId" : "custom resource provider-defined physical id"
}
已失败
删除请求失败时,必须向 S3 存储桶发送包含以下字段的响应:
示例
{ "Status" : "FAILED", "Reason" : "Required failure reason string", "RequestId" : "unique id for this delete request (copied from request)", "LogicalResourceId" : "name of resource in template (copied from request)", "StackId" : "arn:aws:cloudformation:us-east-2:namespace:stack/stack-name/guid (copied from request)", "PhysicalResourceId" : "custom resource provider-defined physical id" }