« blib/lib/Paws/CloudFormation/DeleteStack.pm
↑ Summary
blib/lib/Paws/CloudFormation/DeleteStackInstancesOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::DeleteStackInstances; | ||
| 3 | use Moose; | ||
| 4 | has Accounts => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has CallAs => (is => 'ro', isa => 'Str'); | ||
| 6 | has DeploymentTargets => (is => 'ro', isa => 'Paws::CloudFormation::DeploymentTargets'); | ||
| 7 | has OperationId => (is => 'ro', isa => 'Str'); | ||
| 8 | has OperationPreferences => (is => 'ro', isa => 'Paws::CloudFormation::StackSetOperationPreferences'); | ||
| 9 | has Regions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 10 | has RetainStacks => (is => 'ro', isa => 'Bool', required => 1); | ||
| 11 | has StackSetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteStackInstances'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::DeleteStackInstancesOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DeleteStackInstancesResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CloudFormation::DeleteStackInstances - Arguments for method DeleteStackInstances on L<Paws::CloudFormation> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method DeleteStackInstances on the | ||
| 29 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 30 | as arguments to method DeleteStackInstances. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteStackInstances. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 37 | my $DeleteStackInstancesOutput = $cloudformation->DeleteStackInstances( | ||
| 38 | Regions => [ 'MyRegion', ... ], | ||
| 39 | RetainStacks => 1, | ||
| 40 | StackSetName => 'MyStackSetName', | ||
| 41 | Accounts => [ 'MyAccount', ... ], # OPTIONAL | ||
| 42 | CallAs => 'SELF', # OPTIONAL | ||
| 43 | DeploymentTargets => { | ||
| 44 | Accounts => [ 'MyAccount', ... ], | ||
| 45 | AccountsUrl => 'MyAccountsUrl', # min: 1, max: 5120; OPTIONAL | ||
| 46 | OrganizationalUnitIds => [ 'MyOrganizationalUnitId', ... ], # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | OperationId => 'MyClientRequestToken', # OPTIONAL | ||
| 49 | OperationPreferences => { | ||
| 50 | FailureToleranceCount => 1, # OPTIONAL | ||
| 51 | FailureTolerancePercentage => 1, # max: 100; OPTIONAL | ||
| 52 | MaxConcurrentCount => 1, # min: 1; OPTIONAL | ||
| 53 | MaxConcurrentPercentage => 1, # min: 1, max: 100; OPTIONAL | ||
| 54 | RegionConcurrencyType => | ||
| 55 | 'SEQUENTIAL', # values: SEQUENTIAL, PARALLEL; OPTIONAL | ||
| 56 | RegionOrder => [ 'MyRegion', ... ], | ||
| 57 | }, # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $OperationId = $DeleteStackInstancesOutput->OperationId; | ||
| 62 | |||
| 63 | # Returns a L<Paws::CloudFormation::DeleteStackInstancesOutput> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/DeleteStackInstances> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Accounts => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | [Self-managed permissions] The names of the AWS accounts that you want | ||
| 74 | to delete stack instances for. | ||
| 75 | |||
| 76 | You can specify C<Accounts> or C<DeploymentTargets>, but not both. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 CallAs => Str | ||
| 81 | |||
| 82 | [Service-managed permissions] Specifies whether you are acting as an | ||
| 83 | account administrator in the organization's management account or as a | ||
| 84 | delegated administrator in a member account. | ||
| 85 | |||
| 86 | By default, C<SELF> is specified. Use C<SELF> for stack sets with | ||
| 87 | self-managed permissions. | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | If you are signed in to the management account, specify C<SELF>. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | If you are signed in to a delegated administrator account, specify | ||
| 98 | C<DELEGATED_ADMIN>. | ||
| 99 | |||
| 100 | Your AWS account must be registered as a delegated administrator in the | ||
| 101 | management account. For more information, see Register a delegated | ||
| 102 | administrator | ||
| 103 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) | ||
| 104 | in the I<AWS CloudFormation User Guide>. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | Valid values are: C<"SELF">, C<"DELEGATED_ADMIN"> | ||
| 110 | |||
| 111 | =head2 DeploymentTargets => L<Paws::CloudFormation::DeploymentTargets> | ||
| 112 | |||
| 113 | [Service-managed permissions] The AWS Organizations accounts from which | ||
| 114 | to delete stack instances. | ||
| 115 | |||
| 116 | You can specify C<Accounts> or C<DeploymentTargets>, but not both. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 OperationId => Str | ||
| 121 | |||
| 122 | The unique identifier for this stack set operation. | ||
| 123 | |||
| 124 | If you don't specify an operation ID, the SDK generates one | ||
| 125 | automatically. | ||
| 126 | |||
| 127 | The operation ID also functions as an idempotency token, to ensure that | ||
| 128 | AWS CloudFormation performs the stack set operation only once, even if | ||
| 129 | you retry the request multiple times. You can retry stack set operation | ||
| 130 | requests to ensure that AWS CloudFormation successfully received them. | ||
| 131 | |||
| 132 | Repeating this stack set operation with a new operation ID retries all | ||
| 133 | stack instances whose status is C<OUTDATED>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences> | ||
| 138 | |||
| 139 | Preferences for how AWS CloudFormation performs this stack set | ||
| 140 | operation. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 B<REQUIRED> Regions => ArrayRef[Str|Undef] | ||
| 145 | |||
| 146 | The Regions where you want to delete stack set instances. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 B<REQUIRED> RetainStacks => Bool | ||
| 151 | |||
| 152 | Removes the stack instances from the specified stack set, but doesn't | ||
| 153 | delete the stacks. You can't reassociate a retained stack or add an | ||
| 154 | existing, saved stack to a new stack set. | ||
| 155 | |||
| 156 | For more information, see Stack set operation options | ||
| 157 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> StackSetName => Str | ||
| 162 | |||
| 163 | The name or unique ID of the stack set that you want to delete stack | ||
| 164 | instances for. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, documenting arguments for method DeleteStackInstances in L<Paws::CloudFormation> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |