File Coverage

blib/lib/Paws/CloudFormation/RollbackConfiguration.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::RollbackConfiguration;
2	1	1	641	use Moose;
	1		4
	1		12
3				has MonitoringTimeInMinutes => (is => 'ro', isa => 'Int');
4				has RollbackTriggers => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::RollbackTrigger]');
5				1;
6
7				### main pod documentation begin ###
8
9				=head1 NAME
10
11				Paws::CloudFormation::RollbackConfiguration
12
13				=head1 USAGE
14
15				This class represents one of two things:
16
17				=head3 Arguments in a call to a service
18
19				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20				Each attribute should be used as a named argument in the calls that expect this type of object.
21
22				As an example, if Att1 is expected to be a Paws::CloudFormation::RollbackConfiguration object:
23
24				$service_obj->Method(Att1 => { MonitoringTimeInMinutes => $value, ..., RollbackTriggers => $value });
25
26				=head3 Results returned from an API call
27
28				Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::RollbackConfiguration object:
29
30				$result = $service_obj->Method(...);
31				$result->Att1->MonitoringTimeInMinutes
32
33				=head1 DESCRIPTION
34
35				Structure containing the rollback triggers for AWS CloudFormation to
36				monitor during stack creation and updating operations, and for the
37				specified monitoring period afterwards.
38
39				Rollback triggers enable you to have AWS CloudFormation monitor the
40				state of your application during stack creation and updating, and to
41				roll back that operation if the application breaches the threshold of
42				any of the alarms you've specified. For each rollback trigger you
43				create, you specify the Cloudwatch alarm that CloudFormation should
44				monitor. CloudFormation monitors the specified alarms during the stack
45				create or update operation, and for the specified amount of time after
46				all resources have been deployed. If any of the alarms goes to ALERT
47				state during the stack operation or the monitoring period,
48				CloudFormation rolls back the entire stack operation. If the monitoring
49				period expires without any alarms going to ALERT state, CloudFormation
50				proceeds to dispose of old resources as usual.
51
52				By default, CloudFormation only rolls back stack operations if an alarm
53				goes to ALERT state, not INSUFFICIENT_DATA state. To have
54				CloudFormation roll back the stack operation if an alarm goes to
55				INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat
56				missing data as C<breaching>. For more information, see Configuring How
57				CloudWatch Alarms Treats Missing Data.
58
59				AWS CloudFormation does not monitor rollback triggers when it rolls
60				back a stack during an update operation.
61
62				=head1 ATTRIBUTES
63
64
65				=head2 MonitoringTimeInMinutes => Int
66
67				The amount of time, in minutes, during which CloudFormation should
68				monitor all the rollback triggers after the stack creation or update
69				operation deploys all necessary resources. If any of the alarms goes to
70				ALERT state during the stack operation or this monitoring period,
71				CloudFormation rolls back the entire stack operation. Then, for update
72				operations, if the monitoring period expires without any alarms going
73				to ALERT state CloudFormation proceeds to dispose of old resources as
74				usual.
75
76				If you specify a monitoring period but do not specify any rollback
77				triggers, CloudFormation still waits the specified period of time
78				before cleaning up old resources for update operations. You can use
79				this monitoring period to perform any manual stack validation desired,
80				and manually cancel the stack creation or update (using
81				CancelUpdateStack, for example) as necessary.
82
83				If you specify 0 for this parameter, CloudFormation still monitors the
84				specified rollback triggers during stack creation and update
85				operations. Then, for update operations, it begins disposing of old
86				resources immediately once the operation completes.
87
88
89				=head2 RollbackTriggers => ArrayRef[L<Paws::CloudFormation::RollbackTrigger>]
90
91				The triggers to monitor during stack creation or update actions.
92
93				By default, AWS CloudFormation saves the rollback triggers specified
94				for a stack and applies them to any subsequent update operations for
95				the stack, unless you specify otherwise. If you do specify rollback
96				triggers for this parameter, those triggers replace any list of
97				triggers previously specified for the stack. This means:
98
99				=over
100
101				=item *
102
103				If you don't specify this parameter, AWS CloudFormation uses the
104				rollback triggers previously specified for this stack, if any.
105
106				=item *
107
108				If you specify any rollback triggers using this parameter, you must
109				specify all the triggers that you want used for this stack, even
110				triggers you've specifed before (for example, when creating the stack
111				or during a previous stack update). Any triggers that you don't include
112				in the updated list of triggers are no longer applied to the stack.
113
114				=item *
115
116				If you specify an empty list, AWS CloudFormation removes all currently
117				specified triggers.
118
119				=back
120
121				If a specified Cloudwatch alarm is missing, the entire stack operation
122				fails and is rolled back.
123
124
125
126				=head1 SEE ALSO
127
128				This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
129
130				=head1 BUGS and CONTRIBUTIONS
131
132				The source code is located here: https://github.com/pplu/aws-sdk-perl
133
134				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
135
136				=cut
137