« blib/lib/Paws/CloudFormation/StackSetOperation.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackSetOperationResultSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackSetOperationPreferences; | ||
| 3 | use Moose; | ||
| 4 | has FailureToleranceCount => (is => 'ro', isa => 'Int'); | ||
| 5 | has FailureTolerancePercentage => (is => 'ro', isa => 'Int'); | ||
| 6 | has MaxConcurrentCount => (is => 'ro', isa => 'Int'); | ||
| 7 | has MaxConcurrentPercentage => (is => 'ro', isa => 'Int'); | ||
| 8 | has RegionConcurrencyType => (is => 'ro', isa => 'Str'); | ||
| 9 | has RegionOrder => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudFormation::StackSetOperationPreferences | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperationPreferences object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { FailureToleranceCount => $value, ..., RegionOrder => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperationPreferences object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->FailureToleranceCount | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The user-specified preferences for how AWS CloudFormation performs a | ||
| 42 | stack set operation. | ||
| 43 | |||
| 44 | For more information on maximum concurrent accounts and failure | ||
| 45 | tolerance, see Stack set operation options | ||
| 46 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 FailureToleranceCount => Int | ||
| 52 | |||
| 53 | The number of accounts, per Region, for which this operation can fail | ||
| 54 | before AWS CloudFormation stops the operation in that Region. If the | ||
| 55 | operation is stopped in a Region, AWS CloudFormation doesn't attempt | ||
| 56 | the operation in any subsequent Regions. | ||
| 57 | |||
| 58 | Conditional: You must specify either C<FailureToleranceCount> or | ||
| 59 | C<FailureTolerancePercentage> (but not both). | ||
| 60 | |||
| 61 | By default, C<0> is specified. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 FailureTolerancePercentage => Int | ||
| 65 | |||
| 66 | The percentage of accounts, per Region, for which this stack operation | ||
| 67 | can fail before AWS CloudFormation stops the operation in that Region. | ||
| 68 | If the operation is stopped in a Region, AWS CloudFormation doesn't | ||
| 69 | attempt the operation in any subsequent Regions. | ||
| 70 | |||
| 71 | When calculating the number of accounts based on the specified | ||
| 72 | percentage, AWS CloudFormation rounds I<down> to the next whole number. | ||
| 73 | |||
| 74 | Conditional: You must specify either C<FailureToleranceCount> or | ||
| 75 | C<FailureTolerancePercentage>, but not both. | ||
| 76 | |||
| 77 | By default, C<0> is specified. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxConcurrentCount => Int | ||
| 81 | |||
| 82 | The maximum number of accounts in which to perform this operation at | ||
| 83 | one time. This is dependent on the value of C<FailureToleranceCount>. | ||
| 84 | C<MaxConcurrentCount> is at most one more than the | ||
| 85 | C<FailureToleranceCount>. | ||
| 86 | |||
| 87 | Note that this setting lets you specify the I<maximum> for operations. | ||
| 88 | For large deployments, under certain circumstances the actual number of | ||
| 89 | accounts acted upon concurrently may be lower due to service | ||
| 90 | throttling. | ||
| 91 | |||
| 92 | Conditional: You must specify either C<MaxConcurrentCount> or | ||
| 93 | C<MaxConcurrentPercentage>, but not both. | ||
| 94 | |||
| 95 | By default, C<1> is specified. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 MaxConcurrentPercentage => Int | ||
| 99 | |||
| 100 | The maximum percentage of accounts in which to perform this operation | ||
| 101 | at one time. | ||
| 102 | |||
| 103 | When calculating the number of accounts based on the specified | ||
| 104 | percentage, AWS CloudFormation rounds down to the next whole number. | ||
| 105 | This is true except in cases where rounding down would result is zero. | ||
| 106 | In this case, CloudFormation sets the number as one instead. | ||
| 107 | |||
| 108 | Note that this setting lets you specify the I<maximum> for operations. | ||
| 109 | For large deployments, under certain circumstances the actual number of | ||
| 110 | accounts acted upon concurrently may be lower due to service | ||
| 111 | throttling. | ||
| 112 | |||
| 113 | Conditional: You must specify either C<MaxConcurrentCount> or | ||
| 114 | C<MaxConcurrentPercentage>, but not both. | ||
| 115 | |||
| 116 | By default, C<1> is specified. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 RegionConcurrencyType => Str | ||
| 120 | |||
| 121 | The concurrency type of deploying StackSets operations in regions, | ||
| 122 | could be in parallel or one region at a time. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 RegionOrder => ArrayRef[Str|Undef] | ||
| 126 | |||
| 127 | The order of the Regions in where you want to perform the stack | ||
| 128 | operation. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |