Struct aws_sdk_cloudformation::operation::delete_stack_instances::DeleteStackInstancesInput

#[non_exhaustive]
pub struct DeleteStackInstancesInput {
    pub stack_set_name: Option<String>,
    pub accounts: Option<Vec<String>>,
    pub deployment_targets: Option<DeploymentTargets>,
    pub regions: Option<Vec<String>>,
    pub operation_preferences: Option<StackSetOperationPreferences>,
    pub retain_stacks: Option<bool>,
    pub operation_id: Option<String>,
    pub call_as: Option<CallAs>,
}

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.

stack_set_name: Option<String>

The name or unique ID of the stack set that you want to delete stack instances for.

accounts: Option<Vec<String>>

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

deployment_targets: Option<DeploymentTargets>

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

regions: Option<Vec<String>>

The Amazon Web Services Regions where you want to delete stack set instances.

operation_preferences: Option<StackSetOperationPreferences>

Preferences for how CloudFormation performs this stack set operation.

retain_stacks: Option<bool>

Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see Stack set operation options.

operation_id: Option<String>

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

call_as: Option<CallAs>

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Implementations

impl DeleteStackInstancesInput

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

The name or unique ID of the stack set that you want to delete stack instances for.

pub fn accounts(&self) -> &[String]

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .accounts.is_none().

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

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

pub fn regions(&self) -> &[String]

The Amazon Web Services Regions where you want to delete stack set instances.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .regions.is_none().

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

Preferences for how CloudFormation performs this stack set operation.

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

Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see Stack set operation options.

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

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

pub fn call_as(&self) -> Option<&CallAs>

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

impl DeleteStackInstancesInput

pub fn builder() -> DeleteStackInstancesInputBuilder

Creates a new builder-style object to manufacture DeleteStackInstancesInput.

Trait Implementations

impl Clone for DeleteStackInstancesInput

fn clone(&self) -> DeleteStackInstancesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteStackInstancesInput

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

Formats the value using the given formatter.

impl PartialEq for DeleteStackInstancesInput

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