File Coverage

blib/lib/Paws/CloudFormation/ContinueUpdateRollback.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudFormation::ContinueUpdateRollback;
3 1     1   309 use Moose;
  1         2  
  1         5  
4             has ClientRequestToken => (is => 'ro', isa => 'Str');
5             has ResourcesToSkip => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has RoleARN => (is => 'ro', isa => 'Str');
7             has StackName => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   5342 use MooseX::ClassAttribute;
  1         3  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ContinueUpdateRollback');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::ContinueUpdateRollbackOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'ContinueUpdateRollbackResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::CloudFormation::ContinueUpdateRollback - Arguments for method ContinueUpdateRollback on Paws::CloudFormation
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method ContinueUpdateRollback on the
25             AWS CloudFormation service. Use the attributes of this class
26             as arguments to method ContinueUpdateRollback.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ContinueUpdateRollback.
29              
30             As an example:
31              
32             $service_obj->ContinueUpdateRollback(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 ClientRequestToken => Str
40              
41             A unique identifier for this C<ContinueUpdateRollback> request. Specify
42             this token if you plan to retry requests so that AWS CloudFormation
43             knows that you're not attempting to continue the rollback to a stack
44             with the same name. You might retry C<ContinueUpdateRollback> requests
45             to ensure that AWS CloudFormation successfully received them.
46              
47              
48              
49             =head2 ResourcesToSkip => ArrayRef[Str|Undef]
50              
51             A list of the logical IDs of the resources that AWS CloudFormation
52             skips during the continue update rollback operation. You can specify
53             only resources that are in the C<UPDATE_FAILED> state because a
54             rollback failed. You can't specify resources that are in the
55             C<UPDATE_FAILED> state for other reasons, for example, because an
56             update was cancelled. To check why a resource update failed, use the
57             DescribeStackResources action, and view the resource status reason.
58              
59             Specify this property to skip rolling back resources that AWS
60             CloudFormation can't successfully roll back. We recommend that you
61             troubleshoot resources before skipping them. AWS CloudFormation sets
62             the status of the specified resources to C<UPDATE_COMPLETE> and
63             continues to roll back the stack. After the rollback is complete, the
64             state of the skipped resources will be inconsistent with the state of
65             the resources in the stack template. Before performing another stack
66             update, you must update the stack or resources to be consistent with
67             each other. If you don't, subsequent stack updates might fail, and the
68             stack will become unrecoverable.
69              
70             Specify the minimum number of resources required to successfully roll
71             back your stack. For example, a failed resource update might cause
72             dependent resources to fail. In this case, it might not be necessary to
73             skip the dependent resources.
74              
75             To skip resources that are part of nested stacks, use the following
76             format: C<NestedStackName.ResourceLogicalID>. If you want to specify
77             the logical ID of a stack resource (C<Type:
78             AWS::CloudFormation::Stack>) in the C<ResourcesToSkip> list, then its
79             corresponding embedded stack must be in one of the following states:
80             C<DELETE_IN_PROGRESS>, C<DELETE_COMPLETE>, or C<DELETE_FAILED>.
81              
82             Don't confuse a child stack's name with its corresponding logical ID
83             defined in the parent stack. For an example of a continue update
84             rollback operation with nested stacks, see Using ResourcesToSkip to
85             recover a nested stacks hierarchy.
86              
87              
88              
89             =head2 RoleARN => Str
90              
91             The Amazon Resource Name (ARN) of an AWS Identity and Access Management
92             (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS
93             CloudFormation uses the role's credentials to make calls on your
94             behalf. AWS CloudFormation always uses this role for all future
95             operations on the stack. As long as users have permission to operate on
96             the stack, AWS CloudFormation uses this role even if the users don't
97             have permission to pass it. Ensure that the role grants least
98             privilege.
99              
100             If you don't specify a value, AWS CloudFormation uses the role that was
101             previously associated with the stack. If no role is available, AWS
102             CloudFormation uses a temporary session that is generated from your
103             user credentials.
104              
105              
106              
107             =head2 B<REQUIRED> StackName => Str
108              
109             The name or the unique ID of the stack that you want to continue
110             rolling back.
111              
112             Don't specify the name of a nested stack (a stack that was created by
113             using the C<AWS::CloudFormation::Stack> resource). Instead, use this
114             operation on the parent stack (the stack that contains the
115             C<AWS::CloudFormation::Stack> resource).
116              
117              
118              
119              
120             =head1 SEE ALSO
121              
122             This class forms part of L<Paws>, documenting arguments for method ContinueUpdateRollback in L<Paws::CloudFormation>
123              
124             =head1 BUGS and CONTRIBUTIONS
125              
126             The source code is located here: https://github.com/pplu/aws-sdk-perl
127              
128             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
129              
130             =cut
131