File Coverage

blib/lib/Paws/OpsWorks/CreateInstance.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::CreateInstance;
3 1     1   387 use Moose;
  1         2  
  1         8  
4             has AgentVersion => (is => 'ro', isa => 'Str');
5             has AmiId => (is => 'ro', isa => 'Str');
6             has Architecture => (is => 'ro', isa => 'Str');
7             has AutoScalingType => (is => 'ro', isa => 'Str');
8             has AvailabilityZone => (is => 'ro', isa => 'Str');
9             has BlockDeviceMappings => (is => 'ro', isa => 'ArrayRef[Paws::OpsWorks::BlockDeviceMapping]');
10             has EbsOptimized => (is => 'ro', isa => 'Bool');
11             has Hostname => (is => 'ro', isa => 'Str');
12             has InstallUpdatesOnBoot => (is => 'ro', isa => 'Bool');
13             has InstanceType => (is => 'ro', isa => 'Str', required => 1);
14             has LayerIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
15             has Os => (is => 'ro', isa => 'Str');
16             has RootDeviceType => (is => 'ro', isa => 'Str');
17             has SshKeyName => (is => 'ro', isa => 'Str');
18             has StackId => (is => 'ro', isa => 'Str', required => 1);
19             has SubnetId => (is => 'ro', isa => 'Str');
20             has Tenancy => (is => 'ro', isa => 'Str');
21             has VirtualizationType => (is => 'ro', isa => 'Str');
22              
23 1     1   6254 use MooseX::ClassAttribute;
  1         3  
  1         10  
24              
25             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateInstance');
26             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::OpsWorks::CreateInstanceResult');
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::CreateInstance - Arguments for method CreateInstance on Paws::OpsWorks
35              
36             =head1 DESCRIPTION
37              
38             This class represents the parameters used for calling the method CreateInstance on the
39             AWS OpsWorks service. Use the attributes of this class
40             as arguments to method CreateInstance.
41              
42             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateInstance.
43              
44             As an example:
45              
46             $service_obj->CreateInstance(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             C<INHERIT> - Use the stack's default agent version setting.
63              
64             =item *
65              
66             I<version_number> - Use the specified agent version. This value
67             overrides the stack's default setting. To update the agent version,
68             edit the instance configuration and specify a new version. AWS OpsWorks
69             Stacks then automatically installs that version on the instance.
70              
71             =back
72              
73             The default setting is C<INHERIT>. To specify an agent version, you
74             must use the complete version number, not the abbreviated number shown
75             on the console. For a list of available agent version numbers, call
76             DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
77              
78              
79              
80             =head2 AmiId => Str
81              
82             A custom AMI ID to be used to create the instance. The AMI should be
83             based on one of the supported operating systems. For more information,
84             see Using Custom AMIs.
85              
86             If you specify a custom AMI, you must set C<Os> to C<Custom>.
87              
88              
89              
90             =head2 Architecture => Str
91              
92             The instance architecture. The default option is C<x86_64>. Instance
93             types do not necessarily support both architectures. For a list of the
94             architectures that are supported by the different instance types, see
95             Instance Families and Types.
96              
97             Valid values are: C<"x86_64">, C<"i386">
98              
99             =head2 AutoScalingType => Str
100              
101             For load-based or time-based instances, the type. Windows stacks can
102             use only time-based instances.
103              
104             Valid values are: C<"load">, C<"timer">
105              
106             =head2 AvailabilityZone => Str
107              
108             The instance Availability Zone. For more information, see Regions and
109             Endpoints.
110              
111              
112              
113             =head2 BlockDeviceMappings => ArrayRef[L<Paws::OpsWorks::BlockDeviceMapping>]
114              
115             An array of C<BlockDeviceMapping> objects that specify the instance's
116             block devices. For more information, see Block Device Mapping. Note
117             that block device mappings are not supported for custom AMIs.
118              
119              
120              
121             =head2 EbsOptimized => Bool
122              
123             Whether to create an Amazon EBS-optimized instance.
124              
125              
126              
127             =head2 Hostname => Str
128              
129             The instance host name.
130              
131              
132              
133             =head2 InstallUpdatesOnBoot => Bool
134              
135             Whether to install operating system and package updates when the
136             instance boots. The default value is C<true>. To control when updates
137             are installed, set this value to C<false>. You must then update your
138             instances manually by using CreateDeployment to run the
139             C<update_dependencies> stack command or by manually running C<yum>
140             (Amazon Linux) or C<apt-get> (Ubuntu) on the instances.
141              
142             We strongly recommend using the default value of C<true> to ensure that
143             your instances have the latest security updates.
144              
145              
146              
147             =head2 B<REQUIRED> InstanceType => Str
148              
149             The instance type, such as C<t2.micro>. For a list of supported
150             instance types, open the stack in the console, choose B<Instances>, and
151             choose B<+ Instance>. The B<Size> list contains the currently supported
152             types. For more information, see Instance Families and Types. The
153             parameter values that you use to specify the various types are in the
154             B<API Name> column of the B<Available Instance Types> table.
155              
156              
157              
158             =head2 B<REQUIRED> LayerIds => ArrayRef[Str|Undef]
159              
160             An array that contains the instance's layer IDs.
161              
162              
163              
164             =head2 Os => Str
165              
166             The instance's operating system, which must be set to one of the
167             following.
168              
169             =over
170              
171             =item *
172              
173             A supported Linux operating system: An Amazon Linux version, such as
174             C<Amazon Linux 2017.03>, C<Amazon Linux 2016.09>, C<Amazon Linux
175             2016.03>, C<Amazon Linux 2015.09>, or C<Amazon Linux 2015.03>.
176              
177             =item *
178              
179             A supported Ubuntu operating system, such as C<Ubuntu 16.04 LTS>,
180             C<Ubuntu 14.04 LTS>, or C<Ubuntu 12.04 LTS>.
181              
182             =item *
183              
184             C<CentOS Linux 7>
185              
186             =item *
187              
188             C<Red Hat Enterprise Linux 7>
189              
190             =item *
191              
192             A supported Windows operating system, such as C<Microsoft Windows
193             Server 2012 R2 Base>, C<Microsoft Windows Server 2012 R2 with SQL
194             Server Express>, C<Microsoft Windows Server 2012 R2 with SQL Server
195             Standard>, or C<Microsoft Windows Server 2012 R2 with SQL Server Web>.
196              
197             =item *
198              
199             A custom AMI: C<Custom>.
200              
201             =back
202              
203             For more information on the supported operating systems, see AWS
204             OpsWorks Stacks Operating Systems.
205              
206             The default option is the current Amazon Linux version. If you set this
207             parameter to C<Custom>, you must use the CreateInstance action's AmiId
208             parameter to specify the custom AMI that you want to use. Block device
209             mappings are not supported if the value is C<Custom>. For more
210             information on the supported operating systems, see Operating
211             SystemsFor more information on how to use custom AMIs with AWS OpsWorks
212             Stacks, see Using Custom AMIs.
213              
214              
215              
216             =head2 RootDeviceType => Str
217              
218             The instance root device type. For more information, see Storage for
219             the Root Device.
220              
221             Valid values are: C<"ebs">, C<"instance-store">
222              
223             =head2 SshKeyName => Str
224              
225             The instance's Amazon EC2 key-pair name.
226              
227              
228              
229             =head2 B<REQUIRED> StackId => Str
230              
231             The stack ID.
232              
233              
234              
235             =head2 SubnetId => Str
236              
237             The ID of the instance's subnet. If the stack is running in a VPC, you
238             can use this parameter to override the stack's default subnet ID value
239             and direct AWS OpsWorks Stacks to launch the instance in a different
240             subnet.
241              
242              
243              
244             =head2 Tenancy => Str
245              
246             The instance's tenancy option. The default option is no tenancy, or if
247             the instance is running in a VPC, inherit tenancy settings from the
248             VPC. The following are valid values for this parameter: C<dedicated>,
249             C<default>, or C<host>. Because there are costs associated with changes
250             in tenancy options, we recommend that you research tenancy options
251             before choosing them for your instances. For more information about
252             dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated
253             Hosts. For more information about dedicated instances, see Dedicated
254             Instances and Amazon EC2 Dedicated Instances.
255              
256              
257              
258             =head2 VirtualizationType => Str
259              
260             The instance's virtualization type, C<paravirtual> or C<hvm>.
261              
262              
263              
264              
265             =head1 SEE ALSO
266              
267             This class forms part of L<Paws>, documenting arguments for method CreateInstance in L<Paws::OpsWorks>
268              
269             =head1 BUGS and CONTRIBUTIONS
270              
271             The source code is located here: https://github.com/pplu/aws-sdk-perl
272              
273             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
274              
275             =cut
276