File Coverage

blib/lib/Paws/CloudFormation/StackSetOperationPreferences.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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