自定义资源响应对象 - AWS CloudFormation

自定义资源响应对象

本主题将介绍 CloudFormation 自定义资源的响应对象属性。

有关自定义资源及其工作原理的介绍,请参阅自定义资源

自定义资源提供商响应字段

以下是自定义资源提供程序在将 JSON文件发送到预签名 URL 时包含的属性。有关使用预签名 URL 上传对象的更多信息,请参阅《Amazon Simple Storage Service 用户指南》中的相关主题

注意

响应正文的总大小不能超过 4096 字节。

Status

自定义资源提供商发送的状态值,用于响应AWS CloudFormation-生成的请求。

必须是 SUCCESSFAILED

必需:是

类型:字符串

Reason

描述失败响应的原因。

必需:如果 StatusFAILED 则必须。否则,它是可选的。

类型:字符串

PhysicalResourceId

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

PhysicalResourceId 返回的值可以更改自定义资源更新操作。如果返回的值相同,则将其视为正常更新。如返回的值不同,则 AWS CloudFormation 将该更新视为替换,并向旧资源发送删除请求。有关更多信息,请参阅 AWS::CloudFormation::CustomResource

必需:是

类型:字符串

StackId

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

必需:是

类型:字符串

RequestId

请求的唯一 ID。应从该请求逐字复制此响应值。

必需:是

类型:字符串

LogicalResourceId

AWS CloudFormation 模板中模板开发人员选择的自定义资源的名称(逻辑 ID)。应从该请求逐字复制此响应值。

必需:是

类型:字符串

NoEcho

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

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

必需:否

类型:布尔值

Data

可选。自定义资源提供商定义的名称值对,随响应一起发送。您可以使用 Fn::GetAtt 在模板中按名称访问此处提供的值。

重要

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

必需:否

类型:JSON 对象