自定义资源请求对象
模板开发人员请求属性
template developer 使用 Amazon CloudFormation 资源 AWS::CloudFormation::CustomResource 在模板中指定自定义资源。
在 AWS::CloudFormation::CustomResource 中,所有属性是由custom resource provider定义的。只有一个必需属性:ServiceToken。
资源属性中的所有其他字段是可选字段,并通过该请求的 ResourceProperties 字段逐字发送到 custom resource provider。提供者定义这些字段的名称和有效内容。
Custom resource provider 请求字段
这些字段将以 JSON 请求形式从 Amazon CloudFormation 发送到提供程序为实现此目的而配置的 SNS 主题中的 custom resource provider。
- RequestType
-
请求类型由 Amazon CloudFormation 堆栈操作(创建堆栈、更新堆栈或删除堆栈)设置,而堆栈操作是由包含自定义资源的堆栈的 template developer 启动的。
必须为以下值之一:
Create、Update或Delete。有关更多信息,请参阅 自定义资源请求类型。Required: Yes
Type: String
- ResponseURL
-
响应 URL 标识预签名的 S3 存储桶,该存储桶接收 custom resource provider 到 Amazon CloudFormation 的响应。
Required: Yes
Type: String
- StackId
-
标识包含自定义资源的堆栈的 Amazon 资源名称 (ARN)。
将
StackId与RequestId结合可组成一个值,该值可用于唯一标识对特定自定义资源的请求。Required: Yes
Type: String
- RequestId
-
请求的唯一 ID。
将
StackId与RequestId结合可组成一个值,该值可用于唯一标识对特定自定义资源的请求。Required: Yes
Type: String
- ResourceType
-
Amazon CloudFormation 模板中模板开发人员选择的自定义资源的资源类型。自定义资源类型名称的长度最多为 60 个字符,并且可包含字母数字字符和以下字符:
_@-。Required: Yes
Type: String
- LogicalResourceId
-
Amazon CloudFormation 模板中 template developer 选择的自定义资源名称(逻辑 ID)。 用于促进 custom resource provider 和 template developer 之间的通信。
Required: Yes
Type: String
- PhysicalResourceId
-
custom resource provider 定义的必需物理 ID,该 ID 对于该提供程序是唯一的。
Required: 始终通过
Update和Delete请求来发送;从不通过Create发送。Type: String
- ResourceProperties
-
该字段包含 template developer 发送的
Properties对象的内容。其内容由 custom resource provider 定义。Required: No
Type: JSON object
- OldResourceProperties
-
仅用于
Update请求。包含在更新请求之前声明的资源属性。Required: Yes
Type: JSON object