Update - Amazon CloudFormation
请求响应
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 Amazon Web Services 服务入门。

Update

在对模板内的自定义资源属性进行任何更改时，发送 RequestType 设置为 Update 的自定义资源提供商请求。因此，自定义资源代码不必检测更改，因为它知道其属性在调用 Update 后已更改。

请求

更新请求包含以下字段：

RequestType

Update。

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在更新的 Amazon CloudFormation 模板中声明的新资源属性值。

OldResourceProperties

template developer 以前在 Amazon CloudFormation 模板中声明的资源属性值。

示例

{
   "RequestType" : "Update",
   "RequestId" : "unique id for this update request",
   "ResponseURL" : "pre-signed-url-for-update-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" : "new-string",
      "key2" : [ "new-list" ],
      "key3" : { "key4" : "new-map" }
   },
   "OldResourceProperties" : {
      "key1" : "string",
      "key2" : [ "list" ],
      "key3" : { "key4" : "map" }
   }
}

响应

成功

如果 custom resource provider 可以成功更新资源，Amazon CloudFormation 预计响应中的状态将设置为 SUCCESS。

Status

必须是 SUCCESS。

RequestId

请求的唯一 ID。 此响应值应从请求中复制 verbatim。

LogicalResourceId

Amazon CloudFormation 模板中 template developer 选择的自定义资源名称（逻辑 ID）。 此响应值应从请求中复制 verbatim。

StackId

标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。 此响应值应从请求中复制 verbatim。

PhysicalResourceId

该值应是对于自定义资源供应商具有唯一性的标识符，最大大小为 1 KB。该值必须是非空字符串，并且在所有响应中对于相同资源必须相同。

NoEcho

可选。指示在使用 Fn::GetAtt 函数进行检索时，是否遮蔽定义资源的输出。如果设置为 true，则除模板的 Metadata 区段中存储的值外，所有返回值都将用星号 (*****) 遮蔽。Amazon CloudFormation 不会转换、修改或编辑您在 Metadata 区段中包含的任何信息。默认值为 false。

有关使用 NoEcho 来遮蔽敏感信息的更多信息，请参阅请勿将凭证嵌入您的模板最佳实践。

数据

可选。要在响应中发送的custom resource provider-defined的名称-值对。您可以使用 Fn::GetAtt 在模板中按名称访问此处提供的值。

重要

如果名称-值对包含敏感信息，您应使用 NoEcho 字段遮蔽自定义资源的输出。否则，这些值会通过呈现属性值的 API (例如 DescribeStackEvents) 而显示出来。

示例

{
   "Status" : "SUCCESS",
   "RequestId" : "unique id for this update 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",
   "Data" : {
      "keyThatCanBeUsedInGetAtt1" : "data for key 1",
      "keyThatCanBeUsedInGetAtt2" : "data for key 2"
   }
}

已失败

如果无法使用新属性集更新资源，则 Amazon CloudFormation 预计响应中的状态将设置为 FAILED，并且响应中包含故障原因。

状态

必须是 FAILED。

Reason

描述响应失败的原因。

RequestId

请求的唯一 ID。 此响应值应从请求中复制 verbatim。

LogicalResourceId

Amazon CloudFormation 模板中 template developer 选择的自定义资源名称（逻辑 ID）。 此响应值应从请求中复制 verbatim。

StackId

标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。 此响应值应从请求中复制 verbatim。

PhysicalResourceId

该值应是对于自定义资源供应商具有唯一性的标识符，最大大小为 1 KB。该值必须是非空字符串，并且在所有响应中对于相同资源必须相同。

示例

{
   "Status" : "FAILED",
   "Reason" : "Required failure reason string",
   "RequestId" : "unique id for this update 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"
}