pub enum CfnResponse {
Success {
request_id: String,
logical_resource_id: String,
stack_id: String,
physical_resource_id: String,
no_echo: Option<bool>,
data: Option<Value>,
},
Failed {
reason: String,
request_id: String,
logical_resource_id: String,
stack_id: String,
physical_resource_id: String,
},
}
Expand description
This enum represents the response expected by AWS CloudFormation to a custom resource
modification request (see CfnRequest
). It is serializable into the
required JSON form, such that it can be sent to the pre-signed S3 response-URL provided by AWS
CloudFormation without further modification.
This type should always be constructed from a CfnRequest
using
CfnRequest::into_response
such that the response-fields are pre-filled with
the expected values.
License attribution
The documentation for the fields of the CfnResponse
enum-variants has been taken unmodified
from the AWS CloudFormation Custom Resource Reference, which is licensed under CC BY-SA 4.0.
Variants§
Success
Fields
request_id: String
A unique ID for the request. This response value should be copied verbatim from the request.
logical_resource_id: String
The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request.
stack_id: String
The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. This response value should be copied verbatim from the request.
physical_resource_id: String
This value should be an identifier unique to the custom resource vendor, and can be up to 1 Kb in size. The value must be a non-empty string and must be identical for all responses for the same resource.
Indicates that the modification of the custom resource finished successfully.
This can return data which the AWS CloudFormation template can interact with through the use
of Fn::GetAtt
.
Failed
Fields
request_id: String
A unique ID for the request. This response value should be copied verbatim from the request.
logical_resource_id: String
The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request.
Indicates that the modification of the custom resource failed.
A reason for this failure will be provided.
Trait Implementations§
source§impl Clone for CfnResponse
impl Clone for CfnResponse
source§fn clone(&self) -> CfnResponse
fn clone(&self) -> CfnResponse
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more