Struct aws_sdk_cloudformation::types::StackEvent
source · #[non_exhaustive]pub struct StackEvent {Show 17 fields
pub stack_id: Option<String>,
pub event_id: Option<String>,
pub stack_name: Option<String>,
pub logical_resource_id: Option<String>,
pub physical_resource_id: Option<String>,
pub resource_type: Option<String>,
pub timestamp: Option<DateTime>,
pub resource_status: Option<ResourceStatus>,
pub resource_status_reason: Option<String>,
pub resource_properties: Option<String>,
pub client_request_token: Option<String>,
pub hook_type: Option<String>,
pub hook_status: Option<HookStatus>,
pub hook_status_reason: Option<String>,
pub hook_invocation_point: Option<HookInvocationPoint>,
pub hook_failure_mode: Option<HookFailureMode>,
pub detailed_status: Option<DetailedStatus>,
}
Expand description
The StackEvent data type.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stack_id: Option<String>
The unique ID name of the instance of the stack.
event_id: Option<String>
The unique ID of this event.
stack_name: Option<String>
The name associated with a stack.
logical_resource_id: Option<String>
The logical name of the resource specified in the template.
physical_resource_id: Option<String>
The name or unique identifier associated with the physical instance of the resource.
resource_type: Option<String>
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
timestamp: Option<DateTime>
Time the status was updated.
resource_status: Option<ResourceStatus>
Current status of the resource.
resource_status_reason: Option<String>
Success/failure message associated with the resource.
resource_properties: Option<String>
BLOB of the properties used to create the resource.
client_request_token: Option<String>
The token passed to the operation that generated this event.
All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack
operation with the token token1
, then all the StackEvents
generated by that operation will have ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
hook_type: Option<String>
The name of the hook.
hook_status: Option<HookStatus>
Provides the status of the change set hook.
hook_status_reason: Option<String>
Provides the reason for the hook status.
hook_invocation_point: Option<HookInvocationPoint>
Invocation points are points in provisioning logic where hooks are initiated.
hook_failure_mode: Option<HookFailureMode>
Specify the hook failure mode for non-compliant resources in the followings ways.
-
FAIL
Stops provisioning resources. -
WARN
Allows provisioning to continue with a warning message.
detailed_status: Option<DetailedStatus>
An optional field containing information about the detailed status of the stack event.
-
CONFIGURATION_COMPLETE
- all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
-
VALIDATION_FAILED
- template validation failed because of invalid properties in the template. TheResourceStatusReason
field shows what properties are defined incorrectly.
Implementations§
source§impl StackEvent
impl StackEvent
sourcepub fn stack_name(&self) -> Option<&str>
pub fn stack_name(&self) -> Option<&str>
The name associated with a stack.
sourcepub fn logical_resource_id(&self) -> Option<&str>
pub fn logical_resource_id(&self) -> Option<&str>
The logical name of the resource specified in the template.
sourcepub fn physical_resource_id(&self) -> Option<&str>
pub fn physical_resource_id(&self) -> Option<&str>
The name or unique identifier associated with the physical instance of the resource.
sourcepub fn resource_type(&self) -> Option<&str>
pub fn resource_type(&self) -> Option<&str>
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
sourcepub fn resource_status(&self) -> Option<&ResourceStatus>
pub fn resource_status(&self) -> Option<&ResourceStatus>
Current status of the resource.
sourcepub fn resource_status_reason(&self) -> Option<&str>
pub fn resource_status_reason(&self) -> Option<&str>
Success/failure message associated with the resource.
sourcepub fn resource_properties(&self) -> Option<&str>
pub fn resource_properties(&self) -> Option<&str>
BLOB of the properties used to create the resource.
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
The token passed to the operation that generated this event.
All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack
operation with the token token1
, then all the StackEvents
generated by that operation will have ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
sourcepub fn hook_status(&self) -> Option<&HookStatus>
pub fn hook_status(&self) -> Option<&HookStatus>
Provides the status of the change set hook.
sourcepub fn hook_status_reason(&self) -> Option<&str>
pub fn hook_status_reason(&self) -> Option<&str>
Provides the reason for the hook status.
sourcepub fn hook_invocation_point(&self) -> Option<&HookInvocationPoint>
pub fn hook_invocation_point(&self) -> Option<&HookInvocationPoint>
Invocation points are points in provisioning logic where hooks are initiated.
sourcepub fn hook_failure_mode(&self) -> Option<&HookFailureMode>
pub fn hook_failure_mode(&self) -> Option<&HookFailureMode>
Specify the hook failure mode for non-compliant resources in the followings ways.
-
FAIL
Stops provisioning resources. -
WARN
Allows provisioning to continue with a warning message.
sourcepub fn detailed_status(&self) -> Option<&DetailedStatus>
pub fn detailed_status(&self) -> Option<&DetailedStatus>
An optional field containing information about the detailed status of the stack event.
-
CONFIGURATION_COMPLETE
- all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
-
VALIDATION_FAILED
- template validation failed because of invalid properties in the template. TheResourceStatusReason
field shows what properties are defined incorrectly.
source§impl StackEvent
impl StackEvent
sourcepub fn builder() -> StackEventBuilder
pub fn builder() -> StackEventBuilder
Creates a new builder-style object to manufacture StackEvent
.
Trait Implementations§
source§impl Clone for StackEvent
impl Clone for StackEvent
source§fn clone(&self) -> StackEvent
fn clone(&self) -> StackEvent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StackEvent
impl Debug for StackEvent
source§impl PartialEq for StackEvent
impl PartialEq for StackEvent
source§fn eq(&self, other: &StackEvent) -> bool
fn eq(&self, other: &StackEvent) -> bool
self
and other
values to be equal, and is used
by ==
.