File Coverage

blib/lib/Paws/OpsWorks/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::OpsWorks::UpdateStack;
3 1     1   384 use Moose;
  1         5  
  1         6  
4             has AgentVersion => (is => 'ro', isa => 'Str');
5             has Attributes => (is => 'ro', isa => 'Paws::OpsWorks::StackAttributes');
6             has ChefConfiguration => (is => 'ro', isa => 'Paws::OpsWorks::ChefConfiguration');
7             has ConfigurationManager => (is => 'ro', isa => 'Paws::OpsWorks::StackConfigurationManager');
8             has CustomCookbooksSource => (is => 'ro', isa => 'Paws::OpsWorks::Source');
9             has CustomJson => (is => 'ro', isa => 'Str');
10             has DefaultAvailabilityZone => (is => 'ro', isa => 'Str');
11             has DefaultInstanceProfileArn => (is => 'ro', isa => 'Str');
12             has DefaultOs => (is => 'ro', isa => 'Str');
13             has DefaultRootDeviceType => (is => 'ro', isa => 'Str');
14             has DefaultSshKeyName => (is => 'ro', isa => 'Str');
15             has DefaultSubnetId => (is => 'ro', isa => 'Str');
16             has HostnameTheme => (is => 'ro', isa => 'Str');
17             has Name => (is => 'ro', isa => 'Str');
18             has ServiceRoleArn => (is => 'ro', isa => 'Str');
19             has StackId => (is => 'ro', isa => 'Str', required => 1);
20             has UseCustomCookbooks => (is => 'ro', isa => 'Bool');
21             has UseOpsworksSecurityGroups => (is => 'ro', isa => 'Bool');
22              
23 1     1   5722 use MooseX::ClassAttribute;
  1         2  
  1         10  
24              
25             class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateStack');
26             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
27             class_has _result_key => (isa => 'Str', is => 'ro');
28             1;
29              
30             ### main pod documentation begin ###
31              
32             =head1 NAME
33              
34             Paws::OpsWorks::UpdateStack - Arguments for method UpdateStack on Paws::OpsWorks
35              
36             =head1 DESCRIPTION
37              
38             This class represents the parameters used for calling the method UpdateStack on the
39             AWS OpsWorks service. Use the attributes of this class
40             as arguments to method UpdateStack.
41              
42             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateStack.
43              
44             As an example:
45              
46             $service_obj->UpdateStack(Att1 => $value1, Att2 => $value2, ...);
47              
48             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.
49              
50             =head1 ATTRIBUTES
51              
52              
53             =head2 AgentVersion => Str
54              
55             The default AWS OpsWorks Stacks agent version. You have the following
56             options:
57              
58             =over
59              
60             =item *
61              
62             Auto-update - Set this parameter to C<LATEST>. AWS OpsWorks Stacks
63             automatically installs new agent versions on the stack's instances as
64             soon as they are available.
65              
66             =item *
67              
68             Fixed version - Set this parameter to your preferred agent version. To
69             update the agent version, you must edit the stack configuration and
70             specify a new version. AWS OpsWorks Stacks then automatically installs
71             that version on the stack's instances.
72              
73             =back
74              
75             The default setting is C<LATEST>. To specify an agent version, you must
76             use the complete version number, not the abbreviated number shown on
77             the console. For a list of available agent version numbers, call
78             DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
79              
80             You can also specify an agent version when you create or update an
81             instance, which overrides the stack's default setting.
82              
83              
84              
85             =head2 Attributes => L<Paws::OpsWorks::StackAttributes>
86              
87             One or more user-defined key-value pairs to be added to the stack
88             attributes.
89              
90              
91              
92             =head2 ChefConfiguration => L<Paws::OpsWorks::ChefConfiguration>
93              
94             A C<ChefConfiguration> object that specifies whether to enable
95             Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more
96             information, see Create a New Stack.
97              
98              
99              
100             =head2 ConfigurationManager => L<Paws::OpsWorks::StackConfigurationManager>
101              
102             The configuration manager. When you update a stack, we recommend that
103             you use the configuration manager to specify the Chef version: 12,
104             11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The
105             default value for Linux stacks is currently 11.4.
106              
107              
108              
109             =head2 CustomCookbooksSource => L<Paws::OpsWorks::Source>
110              
111              
112              
113              
114              
115             =head2 CustomJson => Str
116              
117             A string that contains user-defined, custom JSON. It can be used to
118             override the corresponding default stack configuration JSON values or
119             to pass data to recipes. The string should be in the following format:
120              
121             C<"{\"key1\": \"value1\", \"key2\": \"value2\",...}">
122              
123             For more information on custom JSON, see Use Custom JSON to Modify the
124             Stack Configuration Attributes.
125              
126              
127              
128             =head2 DefaultAvailabilityZone => Str
129              
130             The stack's default Availability Zone, which must be in the stack's
131             region. For more information, see Regions and Endpoints. If you also
132             specify a value for C<DefaultSubnetId>, the subnet must be in the same
133             zone. For more information, see CreateStack.
134              
135              
136              
137             =head2 DefaultInstanceProfileArn => Str
138              
139             The ARN of an IAM profile that is the default profile for all of the
140             stack's EC2 instances. For more information about IAM ARNs, see Using
141             Identifiers.
142              
143              
144              
145             =head2 DefaultOs => Str
146              
147             The stack's operating system, which must be set to one of the
148             following:
149              
150             =over
151              
152             =item *
153              
154             A supported Linux operating system: An Amazon Linux version, such as
155             C<Amazon Linux 2017.03>, C<Amazon Linux 2016.09>, C<Amazon Linux
156             2016.03>, C<Amazon Linux 2015.09>, or C<Amazon Linux 2015.03>.
157              
158             =item *
159              
160             A supported Ubuntu operating system, such as C<Ubuntu 16.04 LTS>,
161             C<Ubuntu 14.04 LTS>, or C<Ubuntu 12.04 LTS>.
162              
163             =item *
164              
165             C<CentOS Linux 7>
166              
167             =item *
168              
169             C<Red Hat Enterprise Linux 7>
170              
171             =item *
172              
173             A supported Windows operating system, such as C<Microsoft Windows
174             Server 2012 R2 Base>, C<Microsoft Windows Server 2012 R2 with SQL
175             Server Express>, C<Microsoft Windows Server 2012 R2 with SQL Server
176             Standard>, or C<Microsoft Windows Server 2012 R2 with SQL Server Web>.
177              
178             =item *
179              
180             A custom AMI: C<Custom>. You specify the custom AMI you want to use
181             when you create instances. For more information on how to use custom
182             AMIs with OpsWorks, see Using Custom AMIs.
183              
184             =back
185              
186             The default option is the stack's current operating system. For more
187             information on the supported operating systems, see AWS OpsWorks Stacks
188             Operating Systems.
189              
190              
191              
192             =head2 DefaultRootDeviceType => Str
193              
194             The default root device type. This value is used by default for all
195             instances in the stack, but you can override it when you create an
196             instance. For more information, see Storage for the Root Device.
197              
198             Valid values are: C<"ebs">, C<"instance-store">
199              
200             =head2 DefaultSshKeyName => Str
201              
202             A default Amazon EC2 key-pair name. The default value is C<none>. If
203             you specify a key-pair name, AWS OpsWorks Stacks installs the public
204             key on the instance and you can use the private key with an SSH client
205             to log in to the instance. For more information, see Using SSH to
206             Communicate with an Instance and Managing SSH Access. You can override
207             this setting by specifying a different key pair, or no key pair, when
208             you create an instance.
209              
210              
211              
212             =head2 DefaultSubnetId => Str
213              
214             The stack's default VPC subnet ID. This parameter is required if you
215             specify a value for the C<VpcId> parameter. All instances are launched
216             into this subnet unless you specify otherwise when you create the
217             instance. If you also specify a value for C<DefaultAvailabilityZone>,
218             the subnet must be in that zone. For information on default values and
219             when this parameter is required, see the C<VpcId> parameter
220             description.
221              
222              
223              
224             =head2 HostnameTheme => Str
225              
226             The stack's new host name theme, with spaces replaced by underscores.
227             The theme is used to generate host names for the stack's instances. By
228             default, C<HostnameTheme> is set to C<Layer_Dependent>, which creates
229             host names by appending integers to the layer's short name. The other
230             themes are:
231              
232             =over
233              
234             =item *
235              
236             C<Baked_Goods>
237              
238             =item *
239              
240             C<Clouds>
241              
242             =item *
243              
244             C<Europe_Cities>
245              
246             =item *
247              
248             C<Fruits>
249              
250             =item *
251              
252             C<Greek_Deities>
253              
254             =item *
255              
256             C<Legendary_creatures_from_Japan>
257              
258             =item *
259              
260             C<Planets_and_Moons>
261              
262             =item *
263              
264             C<Roman_Deities>
265              
266             =item *
267              
268             C<Scottish_Islands>
269              
270             =item *
271              
272             C<US_Cities>
273              
274             =item *
275              
276             C<Wild_Cats>
277              
278             =back
279              
280             To obtain a generated host name, call C<GetHostNameSuggestion>, which
281             returns a host name based on the current theme.
282              
283              
284              
285             =head2 Name => Str
286              
287             The stack's new name.
288              
289              
290              
291             =head2 ServiceRoleArn => Str
292              
293             Do not use this parameter. You cannot update a stack's service role.
294              
295              
296              
297             =head2 B<REQUIRED> StackId => Str
298              
299             The stack ID.
300              
301              
302              
303             =head2 UseCustomCookbooks => Bool
304              
305             Whether the stack uses custom cookbooks.
306              
307              
308              
309             =head2 UseOpsworksSecurityGroups => Bool
310              
311             Whether to associate the AWS OpsWorks Stacks built-in security groups
312             with the stack's layers.
313              
314             AWS OpsWorks Stacks provides a standard set of built-in security
315             groups, one for each layer, which are associated with layers by
316             default. C<UseOpsworksSecurityGroups> allows you to provide your own
317             custom security groups instead of using the built-in groups.
318             C<UseOpsworksSecurityGroups> has the following settings:
319              
320             =over
321              
322             =item *
323              
324             True - AWS OpsWorks Stacks automatically associates the appropriate
325             built-in security group with each layer (default setting). You can
326             associate additional security groups with a layer after you create it,
327             but you cannot delete the built-in security group.
328              
329             =item *
330              
331             False - AWS OpsWorks Stacks does not associate built-in security groups
332             with layers. You must create appropriate EC2 security groups and
333             associate a security group with each layer that you create. However,
334             you can still manually associate a built-in security group with a layer
335             on. Custom security groups are required only for those layers that need
336             custom settings.
337              
338             =back
339              
340             For more information, see Create a New Stack.
341              
342              
343              
344              
345             =head1 SEE ALSO
346              
347             This class forms part of L<Paws>, documenting arguments for method UpdateStack in L<Paws::OpsWorks>
348              
349             =head1 BUGS and CONTRIBUTIONS
350              
351             The source code is located here: https://github.com/pplu/aws-sdk-perl
352              
353             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
354              
355             =cut
356