自定义资源响应对象
Custom resource provider 响应字段
以下是自定义资源提供程序在将 JSON文件发送到预签名 URL 时包含的属性。有关使用预签名 URL 上传对象的更多信息,请参阅 Amazon Simple Storage Service 用户指南 中的相关主题。
响应正文的总大小不能超过 4096 字节。
- 状态
-
custom resource provider 为响应 Amazon CloudFormation 生成的请求而发送的状态值。
必须是
SUCCESS
或FAILED
。Required: Yes
Type: String
- Reason
-
描述响应失败的原因。
Required:如果
Status
为FAILED
,则是必需的。否则,它是可选的。Type: String
- PhysicalResourceId
-
该值应是对于自定义资源供应商具有唯一性的标识符,最大大小为 1 KB。该值必须是非空字符串,并且在所有响应中对于相同资源必须相同。
Required: Yes
Type: String
- StackId
-
标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。 此响应值应从请求中复制 verbatim。
Required: Yes
Type: String
- RequestId
-
请求的唯一 ID。 此响应值应从请求中复制 verbatim。
Required: Yes
Type: String
- LogicalResourceId
-
Amazon CloudFormation 模板中 template developer 选择的自定义资源名称(逻辑 ID)。 此响应值应从请求中复制 verbatim。
Required: Yes
Type: String
- NoEcho
-
可选。指示在使用
Fn::GetAtt
函数进行检索时,是否遮蔽定义资源的输出。如果设置为true
,则除模板的Metadata
区段中存储的值外,所有返回值都将用星号 (*****) 遮蔽。Amazon CloudFormation 不会转换、修改或编辑您在Metadata
区段中包含的任何信息。默认值为false
。有关使用
NoEcho
来遮蔽敏感信息的更多信息,请参阅请勿将凭证嵌入您的模板最佳实践。Required: No
Type: Boolean
- Data
-
可选。要在响应中发送的custom resource provider-defined的名称-值对。您可以使用
Fn::GetAtt
在模板中按名称访问此处提供的值。重要 如果名称-值对包含敏感信息,您应使用
NoEcho
字段遮蔽自定义资源的输出。否则,这些值会通过呈现属性值的 API (例如DescribeStackEvents
) 而显示出来。Required: No
Type: JSON object