Enum cloudformatious::StackEvent

pub enum StackEvent {
    Stack {
        resource_status: StackStatus,
        details: StackEventDetails,
    },
    Resource {
        resource_status: ResourceStatus,
        details: StackEventDetails,
    },
}

A stack event from the DescribeStackEvents API.

Stack events are represented as an enum because the API reports both events for the stack and events for the resources in the stack, but these can have different sets of statuses.

Variants

Stack

An event for the stack itself.

Fields of Stack

resource_status: StackStatus

Current status of the stack.

details: StackEventDetails

The details of the event.

Resource

Fields of Resource

resource_status: ResourceStatus

Current status of the resource.

details: StackEventDetails

The details of the event.

Implementations

impl StackEvent

#[must_use]

pub fn resource_status(&self) -> &dyn Status

Get the resource status of the event.

This returns a trait object. You can match on self if you need the specific status type.

#[must_use]

pub fn details(&self) -> &StackEventDetails

Get the details of the event.

#[must_use]

pub fn client_request_token(&self) -> Option<&str>

Get the token passed to the operation that generated this event.

All events triggerd by a given stack operation are assigne dthe same client request token, 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.

#[must_use]

pub fn event_id(&self) -> &str

Get the unique ID of this event.

#[must_use]

pub fn logical_resource_id(&self) -> &str

Get the logical name of the resource specified in the template.

#[must_use]

pub fn physical_resource_id(&self) -> Option<&str>

Get the name of unique identifier associated with the physical instance of the resource.

This is unset when a physical resource does not exist, e.g. when creation is still in progress or has failed.

#[must_use]

pub fn resource_status_reason(&self) -> Option<&str>

Get the success/failure message associated with the resource.

#[must_use]

pub fn resource_type(&self) -> &str

Get the type of resource.

#[must_use]

pub fn stack_id(&self) -> &str

Get the unique ID of the instance of the stack.

#[must_use]

pub fn stack_name(&self) -> &str

Get the name associated with the stack.

#[must_use]

pub fn timestamp(&self) -> &DateTime<Utc>

Get the time the status was updated.

#[must_use]

pub fn is_terminal(&self) -> bool

Indicates whether or not an event is terminal.

A terminal event is the last one that will occur during the current stack operation. By definition, the terminal event is an event for the stack itself with a terminal StackStatus.

Trait Implementations

impl Clone for StackEvent

fn clone(&self) -> StackEvent

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StackEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for StackEvent

impl PartialEq<StackEvent> for StackEvent

fn eq(&self, other: &StackEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StackEvent) -> bool

This method tests for !=.

impl StructuralEq for StackEvent

impl StructuralPartialEq for StackEvent