File Coverage

blib/lib/Paws/CloudFormation/UpdateStack.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::UpdateStack;
3 1     1   328 use Moose;
  1         3  
  1         5  
4             has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has ClientRequestToken => (is => 'ro', isa => 'Str');
6             has NotificationARNs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]');
8             has ResourceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has RoleARN => (is => 'ro', isa => 'Str');
10             has RollbackConfiguration => (is => 'ro', isa => 'Paws::CloudFormation::RollbackConfiguration');
11             has StackName => (is => 'ro', isa => 'Str', required => 1);
12             has StackPolicyBody => (is => 'ro', isa => 'Str');
13             has StackPolicyDuringUpdateBody => (is => 'ro', isa => 'Str');
14             has StackPolicyDuringUpdateURL => (is => 'ro', isa => 'Str');
15             has StackPolicyURL => (is => 'ro', isa => 'Str');
16             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]');
17             has TemplateBody => (is => 'ro', isa => 'Str');
18             has TemplateURL => (is => 'ro', isa => 'Str');
19             has UsePreviousTemplate => (is => 'ro', isa => 'Bool');
20              
21 1     1   5388 use MooseX::ClassAttribute;
  1         2  
  1         7  
22              
23             class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateStack');
24             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::UpdateStackOutput');
25             class_has _result_key => (isa => 'Str', is => 'ro', default => 'UpdateStackResult');
26             1;
27              
28             ### main pod documentation begin ###
29              
30             =head1 NAME
31              
32             Paws::CloudFormation::UpdateStack - Arguments for method UpdateStack on Paws::CloudFormation
33              
34             =head1 DESCRIPTION
35              
36             This class represents the parameters used for calling the method UpdateStack on the
37             AWS CloudFormation service. Use the attributes of this class
38             as arguments to method UpdateStack.
39              
40             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateStack.
41              
42             As an example:
43              
44             $service_obj->UpdateStack(Att1 => $value1, Att2 => $value2, ...);
45              
46             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.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 Capabilities => ArrayRef[Str|Undef]
52              
53             A list of values that you must specify before AWS CloudFormation can
54             update certain stacks. Some stack templates might include resources
55             that can affect permissions in your AWS account, for example, by
56             creating new AWS Identity and Access Management (IAM) users. For those
57             stacks, you must explicitly acknowledge their capabilities by
58             specifying this parameter.
59              
60             The only valid values are C<CAPABILITY_IAM> and
61             C<CAPABILITY_NAMED_IAM>. The following resources require you to specify
62             this parameter: AWS::IAM::AccessKey, AWS::IAM::Group,
63             AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role,
64             AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack
65             template contains these resources, we recommend that you review all
66             permissions associated with them and edit their permissions if
67             necessary.
68              
69             If you have IAM resources, you can specify either capability. If you
70             have IAM resources with custom names, you must specify
71             C<CAPABILITY_NAMED_IAM>. If you don't specify this parameter, this
72             action returns an C<InsufficientCapabilities> error.
73              
74             For more information, see Acknowledging IAM Resources in AWS
75             CloudFormation Templates.
76              
77              
78              
79             =head2 ClientRequestToken => Str
80              
81             A unique identifier for this C<UpdateStack> request. Specify this token
82             if you plan to retry requests so that AWS CloudFormation knows that
83             you're not attempting to update a stack with the same name. You might
84             retry C<UpdateStack> requests to ensure that AWS CloudFormation
85             successfully received them.
86              
87             All events triggered by a given stack operation are assigned the same
88             client request token, which you can use to track operations. For
89             example, if you execute a C<CreateStack> operation with the token
90             C<token1>, then all the C<StackEvents> generated by that operation will
91             have C<ClientRequestToken> set as C<token1>.
92              
93             In the console, stack operations display the client request token on
94             the Events tab. Stack operations that are initiated from the console
95             use the token format I<Console-StackOperation-ID>, which helps you
96             easily identify the stack operation . For example, if you create a
97             stack using the console, each stack event would be assigned the same
98             token in the following format:
99             C<Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002>.
100              
101              
102              
103             =head2 NotificationARNs => ArrayRef[Str|Undef]
104              
105             Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
106             that AWS CloudFormation associates with the stack. Specify an empty
107             list to remove all notification topics.
108              
109              
110              
111             =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>]
112              
113             A list of C<Parameter> structures that specify input parameters for the
114             stack. For more information, see the Parameter data type.
115              
116              
117              
118             =head2 ResourceTypes => ArrayRef[Str|Undef]
119              
120             The template resource types that you have permissions to work with for
121             this update stack action, such as C<AWS::EC2::Instance>,
122             C<AWS::EC2::*>, or C<Custom::MyCustomInstance>.
123              
124             If the list of resource types doesn't include a resource that you're
125             updating, the stack update fails. By default, AWS CloudFormation grants
126             permissions to all resource types. AWS Identity and Access Management
127             (IAM) uses this parameter for AWS CloudFormation-specific condition
128             keys in IAM policies. For more information, see Controlling Access with
129             AWS Identity and Access Management.
130              
131              
132              
133             =head2 RoleARN => Str
134              
135             The Amazon Resource Name (ARN) of an AWS Identity and Access Management
136             (IAM) role that AWS CloudFormation assumes to update the stack. AWS
137             CloudFormation uses the role's credentials to make calls on your
138             behalf. AWS CloudFormation always uses this role for all future
139             operations on the stack. As long as users have permission to operate on
140             the stack, AWS CloudFormation uses this role even if the users don't
141             have permission to pass it. Ensure that the role grants least
142             privilege.
143              
144             If you don't specify a value, AWS CloudFormation uses the role that was
145             previously associated with the stack. If no role is available, AWS
146             CloudFormation uses a temporary session that is generated from your
147             user credentials.
148              
149              
150              
151             =head2 RollbackConfiguration => L<Paws::CloudFormation::RollbackConfiguration>
152              
153             The rollback triggers for AWS CloudFormation to monitor during stack
154             creation and updating operations, and for the specified monitoring
155             period afterwards.
156              
157              
158              
159             =head2 B<REQUIRED> StackName => Str
160              
161             The name or unique stack ID of the stack to update.
162              
163              
164              
165             =head2 StackPolicyBody => Str
166              
167             Structure containing a new stack policy body. You can specify either
168             the C<StackPolicyBody> or the C<StackPolicyURL> parameter, but not
169             both.
170              
171             You might update the stack policy, for example, in order to protect a
172             new resource that you created during a stack update. If you do not
173             specify a stack policy, the current policy that is associated with the
174             stack is unchanged.
175              
176              
177              
178             =head2 StackPolicyDuringUpdateBody => Str
179              
180             Structure containing the temporary overriding stack policy body. You
181             can specify either the C<StackPolicyDuringUpdateBody> or the
182             C<StackPolicyDuringUpdateURL> parameter, but not both.
183              
184             If you want to update protected resources, specify a temporary
185             overriding stack policy during this update. If you do not specify a
186             stack policy, the current policy that is associated with the stack will
187             be used.
188              
189              
190              
191             =head2 StackPolicyDuringUpdateURL => Str
192              
193             Location of a file containing the temporary overriding stack policy.
194             The URL must point to a policy (max size: 16KB) located in an S3 bucket
195             in the same region as the stack. You can specify either the
196             C<StackPolicyDuringUpdateBody> or the C<StackPolicyDuringUpdateURL>
197             parameter, but not both.
198              
199             If you want to update protected resources, specify a temporary
200             overriding stack policy during this update. If you do not specify a
201             stack policy, the current policy that is associated with the stack will
202             be used.
203              
204              
205              
206             =head2 StackPolicyURL => Str
207              
208             Location of a file containing the updated stack policy. The URL must
209             point to a policy (max size: 16KB) located in an S3 bucket in the same
210             region as the stack. You can specify either the C<StackPolicyBody> or
211             the C<StackPolicyURL> parameter, but not both.
212              
213             You might update the stack policy, for example, in order to protect a
214             new resource that you created during a stack update. If you do not
215             specify a stack policy, the current policy that is associated with the
216             stack is unchanged.
217              
218              
219              
220             =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>]
221              
222             Key-value pairs to associate with this stack. AWS CloudFormation also
223             propagates these tags to supported resources in the stack. You can
224             specify a maximum number of 50 tags.
225              
226             If you don't specify this parameter, AWS CloudFormation doesn't modify
227             the stack's tags. If you specify an empty value, AWS CloudFormation
228             removes all associated tags.
229              
230              
231              
232             =head2 TemplateBody => Str
233              
234             Structure containing the template body with a minimum length of 1 byte
235             and a maximum length of 51,200 bytes. (For more information, go to
236             Template Anatomy in the AWS CloudFormation User Guide.)
237              
238             Conditional: You must specify only one of the following parameters:
239             C<TemplateBody>, C<TemplateURL>, or set the C<UsePreviousTemplate> to
240             C<true>.
241              
242              
243              
244             =head2 TemplateURL => Str
245              
246             Location of file containing the template body. The URL must point to a
247             template that is located in an Amazon S3 bucket. For more information,
248             go to Template Anatomy in the AWS CloudFormation User Guide.
249              
250             Conditional: You must specify only one of the following parameters:
251             C<TemplateBody>, C<TemplateURL>, or set the C<UsePreviousTemplate> to
252             C<true>.
253              
254              
255              
256             =head2 UsePreviousTemplate => Bool
257              
258             Reuse the existing template that is associated with the stack that you
259             are updating.
260              
261             Conditional: You must specify only one of the following parameters:
262             C<TemplateBody>, C<TemplateURL>, or set the C<UsePreviousTemplate> to
263             C<true>.
264              
265              
266              
267              
268             =head1 SEE ALSO
269              
270             This class forms part of L<Paws>, documenting arguments for method UpdateStack in L<Paws::CloudFormation>
271              
272             =head1 BUGS and CONTRIBUTIONS
273              
274             The source code is located here: https://github.com/pplu/aws-sdk-perl
275              
276             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
277              
278             =cut
279