/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudFormation::DeleteStackInstances

NAME

Paws::CloudFormation::DeleteStackInstances - Arguments for method DeleteStackInstances on Paws::CloudFormation

DESCRIPTION

This class represents the parameters used for calling the method DeleteStackInstances on the AWS CloudFormation service. Use the attributes of this class as arguments to method DeleteStackInstances.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteStackInstances.

SYNOPSIS

my $cloudformation = Paws->service('CloudFormation');
my $DeleteStackInstancesOutput = $cloudformation->DeleteStackInstances(
  Regions           => [ 'MyRegion', ... ],
  RetainStacks      => 1,
  StackSetName      => 'MyStackSetName',
  Accounts          => [ 'MyAccount', ... ],    # OPTIONAL
  CallAs            => 'SELF',                  # OPTIONAL
  DeploymentTargets => {
    Accounts    => [ 'MyAccount', ... ],
    AccountsUrl => 'MyAccountsUrl',        # min: 1, max: 5120; OPTIONAL
    OrganizationalUnitIds => [ 'MyOrganizationalUnitId', ... ],   # OPTIONAL
  },    # OPTIONAL
  OperationId          => 'MyClientRequestToken',    # OPTIONAL
  OperationPreferences => {
    FailureToleranceCount      => 1,    # OPTIONAL
    FailureTolerancePercentage => 1,    # max: 100; OPTIONAL
    MaxConcurrentCount         => 1,    # min: 1; OPTIONAL
    MaxConcurrentPercentage    => 1,    # min: 1, max: 100; OPTIONAL
    RegionConcurrencyType      =>
      'SEQUENTIAL',    # values: SEQUENTIAL, PARALLEL; OPTIONAL
    RegionOrder => [ 'MyRegion', ... ],
  },    # OPTIONAL
);

# Results:
my $OperationId = $DeleteStackInstancesOutput->OperationId;

# Returns a L<Paws::CloudFormation::DeleteStackInstancesOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudformation/DeleteStackInstances

ATTRIBUTES

Accounts => ArrayRef[Str|Undef]

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

You can specify Accounts or DeploymentTargets, but not both.

CallAs => Str

[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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the AWS CloudFormation User Guide.

Valid values are: "SELF", "DELEGATED_ADMIN"

DeploymentTargets => Paws::CloudFormation::DeploymentTargets

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

You can specify Accounts or DeploymentTargets, but not both.

OperationId => 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 AWS 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 AWS CloudFormation successfully received them.

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

OperationPreferences => Paws::CloudFormation::StackSetOperationPreferences

Preferences for how AWS CloudFormation performs this stack set operation.

REQUIRED Regions => ArrayRef[Str|Undef]

The Regions where you want to delete stack set instances.

REQUIRED RetainStacks => 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).

REQUIRED StackSetName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteStackInstances in Paws::CloudFormation

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues