Struct aws_sdk_cloudformation::types::StackSetOperation

#[non_exhaustive]
pub struct StackSetOperation {

    pub operation_id: Option<String>,
    pub stack_set_id: Option<String>,
    pub action: Option<StackSetOperationAction>,
    pub status: Option<StackSetOperationStatus>,
    pub operation_preferences: Option<StackSetOperationPreferences>,
    pub retain_stacks: Option<bool>,
    pub administration_role_arn: Option<String>,
    pub execution_role_name: Option<String>,
    pub creation_timestamp: Option<DateTime>,
    pub end_timestamp: Option<DateTime>,
    pub deployment_targets: Option<DeploymentTargets>,
    pub stack_set_drift_detection_details: Option<StackSetDriftDetectionDetails>,
    pub status_reason: Option<String>,
    pub status_details: Option<StackSetOperationStatusDetails>,
}

The structure that contains information about a stack set 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 a stack set operation.

stack_set_id: Option<String>

The ID of the stack set.

action: Option<StackSetOperationAction>

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

status: Option<StackSetOperationStatus>

The 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.

operation_preferences: Option<StackSetOperationPreferences>

The preferences for how CloudFormation performs this stack set operation.

retain_stacks: Option<bool>

For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

administration_role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

execution_role_name: Option<String>

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

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.

deployment_targets: Option<DeploymentTargets>

[Service-managed permissions] The Organizations accounts affected by the stack operation.

stack_set_drift_detection_details: Option<StackSetDriftDetectionDetails>

Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.

status_reason: Option<String>

The status of the operation in details.

status_details: Option<StackSetOperationStatusDetails>

Detailed information about the StackSet operation.

Implementations

impl StackSetOperation

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

The unique ID of a stack set operation.

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

The ID of the stack set.

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

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

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

The 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 operation_preferences(&self) -> Option<&StackSetOperationPreferences>

The preferences for how CloudFormation performs this stack set operation.

pub fn retain_stacks(&self) -> Option<bool>

For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

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

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

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

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

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 deployment_targets(&self) -> Option<&DeploymentTargets>

[Service-managed permissions] The Organizations accounts affected by the stack operation.

pub fn stack_set_drift_detection_details( &self ) -> Option<&StackSetDriftDetectionDetails>

Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.

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 StackSet operation.

impl StackSetOperation

pub fn builder() -> StackSetOperationBuilder

Creates a new builder-style object to manufacture StackSetOperation.

Trait Implementations

impl Clone for StackSetOperation

fn clone(&self) -> StackSetOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackSetOperation

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

Formats the value using the given formatter.

impl PartialEq for StackSetOperation

fn eq(&self, other: &StackSetOperation) -> 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 StackSetOperation