Struct aws_sdk_cloudformation::types::builders::StackSetOperationBuilder

#[non_exhaustive]
pub struct StackSetOperationBuilder { /* private fields */ }

A builder for StackSetOperation.

Implementations

impl StackSetOperationBuilder

pub fn operation_id(self, input: impl Into<String>) -> Self

The unique ID of a stack set operation.

pub fn set_operation_id(self, input: Option<String>) -> Self

The unique ID of a stack set operation.

pub fn get_operation_id(&self) -> &Option<String>

The unique ID of a stack set operation.

pub fn stack_set_id(self, input: impl Into<String>) -> Self

The ID of the stack set.

pub fn set_stack_set_id(self, input: Option<String>) -> Self

The ID of the stack set.

pub fn get_stack_set_id(&self) -> &Option<String>

The ID of the stack set.

pub fn action(self, input: StackSetOperationAction) -> Self

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 set_action(self, input: Option<StackSetOperationAction>) -> Self

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 get_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, input: StackSetOperationStatus) -> Self

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 set_status(self, input: Option<StackSetOperationStatus>) -> Self

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 get_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, input: StackSetOperationPreferences) -> Self

The preferences for how CloudFormation performs this stack set operation.

pub fn set_operation_preferences( self, input: Option<StackSetOperationPreferences> ) -> Self

The preferences for how CloudFormation performs this stack set operation.

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

The preferences for how CloudFormation performs this stack set operation.

pub fn retain_stacks(self, input: bool) -> Self

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 set_retain_stacks(self, input: Option<bool>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_administration_role_arn(self, input: Option<String>) -> Self

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 get_administration_role_arn(&self) -> &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.

pub fn execution_role_name(self, input: impl Into<String>) -> Self

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 set_execution_role_name(self, input: Option<String>) -> Self

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 get_execution_role_name(&self) -> &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.

pub fn creation_timestamp(self, input: DateTime) -> Self

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 set_creation_timestamp(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_end_timestamp(self, input: Option<DateTime>) -> Self

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 get_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, input: DeploymentTargets) -> Self

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

pub fn set_deployment_targets(self, input: Option<DeploymentTargets>) -> Self

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

pub fn get_deployment_targets(&self) -> &Option<DeploymentTargets>

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

pub fn stack_set_drift_detection_details( self, input: StackSetDriftDetectionDetails ) -> Self

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 set_stack_set_drift_detection_details( self, input: Option<StackSetDriftDetectionDetails> ) -> Self

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 get_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, input: impl Into<String>) -> Self

The status of the operation in details.

pub fn set_status_reason(self, input: Option<String>) -> Self

The status of the operation in details.

pub fn get_status_reason(&self) -> &Option<String>

The status of the operation in details.

pub fn status_details(self, input: StackSetOperationStatusDetails) -> Self

Detailed information about the StackSet operation.

pub fn set_status_details( self, input: Option<StackSetOperationStatusDetails> ) -> Self

Detailed information about the StackSet operation.

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

Detailed information about the StackSet operation.

pub fn build(self) -> StackSetOperation

Consumes the builder and constructs a StackSetOperation.

Trait Implementations

impl Clone for StackSetOperationBuilder

fn clone(&self) -> StackSetOperationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackSetOperationBuilder

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

Formats the value using the given formatter.

impl Default for StackSetOperationBuilder

fn default() -> StackSetOperationBuilder

Returns the “default value” for a type.

impl PartialEq for StackSetOperationBuilder

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