Struct aws_sdk_cloudformation::types::StackSetOperationSummary

#[non_exhaustive]
pub struct StackSetOperationSummary {
    pub operation_id: Option<String>,
    pub action: Option<StackSetOperationAction>,
    pub status: Option<StackSetOperationStatus>,
    pub creation_timestamp: Option<DateTime>,
    pub end_timestamp: Option<DateTime>,
    pub status_reason: Option<String>,
    pub status_details: Option<StackSetOperationStatusDetails>,
    pub operation_preferences: Option<StackSetOperationPreferences>,
}

The structures that contain summary information about the specified operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

operation_id: Option<String>

The unique ID of the stack set operation.

action: Option<StackSetOperationAction>

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

status: Option<StackSetOperationStatus>

The overall status of the operation.

• FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

• QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has canceled the operation.

• STOPPING: The operation is in the process of stopping, at user request.

• SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

creation_timestamp: Option<DateTime>

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

end_timestamp: Option<DateTime>

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

status_reason: Option<String>

The status of the operation in details.

status_details: Option<StackSetOperationStatusDetails>

Detailed information about the stack set operation.

operation_preferences: Option<StackSetOperationPreferences>

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

Implementations

impl StackSetOperationSummary

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

The unique ID of the stack set operation.

pub fn action(&self) -> Option<&StackSetOperationAction>

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

pub fn status(&self) -> Option<&StackSetOperationStatus>

The overall status of the operation.

• FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

• QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has canceled the operation.

• STOPPING: The operation is in the process of stopping, at user request.

• SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

pub fn creation_timestamp(&self) -> Option<&DateTime>

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

pub fn end_timestamp(&self) -> Option<&DateTime>

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

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

The status of the operation in details.

pub fn status_details(&self) -> Option<&StackSetOperationStatusDetails>

Detailed information about the stack set operation.

pub fn operation_preferences(&self) -> Option<&StackSetOperationPreferences>

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

impl StackSetOperationSummary

pub fn builder() -> StackSetOperationSummaryBuilder

Creates a new builder-style object to manufacture StackSetOperationSummary.

Trait Implementations

impl Clone for StackSetOperationSummary

fn clone(&self) -> StackSetOperationSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackSetOperationSummary

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

Formats the value using the given formatter.

impl PartialEq for StackSetOperationSummary

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StackSetOperationSummary