line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::OpsWorksCM::CreateServer; |
3
|
1
|
|
|
1
|
|
494
|
use Moose; |
|
1
|
|
|
|
|
12
|
|
|
1
|
|
|
|
|
7
|
|
4
|
|
|
|
|
|
|
has AssociatePublicIpAddress => (is => 'ro', isa => 'Bool'); |
5
|
|
|
|
|
|
|
has BackupId => (is => 'ro', isa => 'Str'); |
6
|
|
|
|
|
|
|
has BackupRetentionCount => (is => 'ro', isa => 'Int'); |
7
|
|
|
|
|
|
|
has DisableAutomatedBackup => (is => 'ro', isa => 'Bool'); |
8
|
|
|
|
|
|
|
has Engine => (is => 'ro', isa => 'Str'); |
9
|
|
|
|
|
|
|
has EngineAttributes => (is => 'ro', isa => 'ArrayRef[Paws::OpsWorksCM::EngineAttribute]'); |
10
|
|
|
|
|
|
|
has EngineModel => (is => 'ro', isa => 'Str'); |
11
|
|
|
|
|
|
|
has EngineVersion => (is => 'ro', isa => 'Str'); |
12
|
|
|
|
|
|
|
has InstanceProfileArn => (is => 'ro', isa => 'Str', required => 1); |
13
|
|
|
|
|
|
|
has InstanceType => (is => 'ro', isa => 'Str', required => 1); |
14
|
|
|
|
|
|
|
has KeyPair => (is => 'ro', isa => 'Str'); |
15
|
|
|
|
|
|
|
has PreferredBackupWindow => (is => 'ro', isa => 'Str'); |
16
|
|
|
|
|
|
|
has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); |
17
|
|
|
|
|
|
|
has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); |
18
|
|
|
|
|
|
|
has ServerName => (is => 'ro', isa => 'Str', required => 1); |
19
|
|
|
|
|
|
|
has ServiceRoleArn => (is => 'ro', isa => 'Str', required => 1); |
20
|
|
|
|
|
|
|
has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); |
21
|
|
|
|
|
|
|
|
22
|
1
|
|
|
1
|
|
6378
|
use MooseX::ClassAttribute; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
9
|
|
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateServer'); |
25
|
|
|
|
|
|
|
class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::OpsWorksCM::CreateServerResponse'); |
26
|
|
|
|
|
|
|
class_has _result_key => (isa => 'Str', is => 'ro'); |
27
|
|
|
|
|
|
|
1; |
28
|
|
|
|
|
|
|
|
29
|
|
|
|
|
|
|
### main pod documentation begin ### |
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=head1 NAME |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
Paws::OpsWorksCM::CreateServer - Arguments for method CreateServer on Paws::OpsWorksCM |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
=head1 DESCRIPTION |
36
|
|
|
|
|
|
|
|
37
|
|
|
|
|
|
|
This class represents the parameters used for calling the method CreateServer on the |
38
|
|
|
|
|
|
|
AWS OpsWorks for Chef Automate service. Use the attributes of this class |
39
|
|
|
|
|
|
|
as arguments to method CreateServer. |
40
|
|
|
|
|
|
|
|
41
|
|
|
|
|
|
|
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateServer. |
42
|
|
|
|
|
|
|
|
43
|
|
|
|
|
|
|
As an example: |
44
|
|
|
|
|
|
|
|
45
|
|
|
|
|
|
|
$service_obj->CreateServer(Att1 => $value1, Att2 => $value2, ...); |
46
|
|
|
|
|
|
|
|
47
|
|
|
|
|
|
|
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. |
48
|
|
|
|
|
|
|
|
49
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
50
|
|
|
|
|
|
|
|
51
|
|
|
|
|
|
|
|
52
|
|
|
|
|
|
|
=head2 AssociatePublicIpAddress => Bool |
53
|
|
|
|
|
|
|
|
54
|
|
|
|
|
|
|
Associate a public IP address with a server that you are launching. |
55
|
|
|
|
|
|
|
Valid values are C<true> or C<false>. The default value is C<true>. |
56
|
|
|
|
|
|
|
|
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
|
59
|
|
|
|
|
|
|
=head2 BackupId => Str |
60
|
|
|
|
|
|
|
|
61
|
|
|
|
|
|
|
If you specify this field, AWS OpsWorks for Chef Automate creates the |
62
|
|
|
|
|
|
|
server by using the backup represented by BackupId. |
63
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
|
65
|
|
|
|
|
|
|
|
66
|
|
|
|
|
|
|
=head2 BackupRetentionCount => Int |
67
|
|
|
|
|
|
|
|
68
|
|
|
|
|
|
|
The number of automated backups that you want to keep. Whenever a new |
69
|
|
|
|
|
|
|
backup is created, AWS OpsWorks for Chef Automate deletes the oldest |
70
|
|
|
|
|
|
|
backups if this number is exceeded. The default value is C<1>. |
71
|
|
|
|
|
|
|
|
72
|
|
|
|
|
|
|
|
73
|
|
|
|
|
|
|
|
74
|
|
|
|
|
|
|
=head2 DisableAutomatedBackup => Bool |
75
|
|
|
|
|
|
|
|
76
|
|
|
|
|
|
|
Enable or disable scheduled backups. Valid values are C<true> or |
77
|
|
|
|
|
|
|
C<false>. The default value is C<true>. |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
|
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
=head2 Engine => Str |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
The configuration management engine to use. Valid values include |
84
|
|
|
|
|
|
|
C<Chef>. |
85
|
|
|
|
|
|
|
|
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
|
88
|
|
|
|
|
|
|
=head2 EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>] |
89
|
|
|
|
|
|
|
|
90
|
|
|
|
|
|
|
Optional engine attributes on a specified server. |
91
|
|
|
|
|
|
|
|
92
|
|
|
|
|
|
|
B<Attributes accepted in a createServer request:> |
93
|
|
|
|
|
|
|
|
94
|
|
|
|
|
|
|
=over |
95
|
|
|
|
|
|
|
|
96
|
|
|
|
|
|
|
=item * |
97
|
|
|
|
|
|
|
|
98
|
|
|
|
|
|
|
C<CHEF_PIVOTAL_KEY>: A base64-encoded RSA private key that is not |
99
|
|
|
|
|
|
|
stored by AWS OpsWorks for Chef. This private key is required to access |
100
|
|
|
|
|
|
|
the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and |
101
|
|
|
|
|
|
|
returned in the response. |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
=item * |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
C<CHEF_DELIVERY_ADMIN_PASSWORD>: The password for the administrative |
106
|
|
|
|
|
|
|
user in the Chef Automate GUI. The password length is a minimum of |
107
|
|
|
|
|
|
|
eight characters, and a maximum of 32. The password can contain |
108
|
|
|
|
|
|
|
letters, numbers, and special characters (!/@#$%^&+=_). The password |
109
|
|
|
|
|
|
|
must contain at least one lower case letter, one upper case letter, one |
110
|
|
|
|
|
|
|
number, and one special character. When no CHEF_DELIVERY_ADMIN_PASSWORD |
111
|
|
|
|
|
|
|
is set, one is generated and returned in the response. |
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
=back |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
|
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
|
118
|
|
|
|
|
|
|
=head2 EngineModel => Str |
119
|
|
|
|
|
|
|
|
120
|
|
|
|
|
|
|
The engine model, or option. Valid values include C<Single>. |
121
|
|
|
|
|
|
|
|
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
|
124
|
|
|
|
|
|
|
=head2 EngineVersion => Str |
125
|
|
|
|
|
|
|
|
126
|
|
|
|
|
|
|
The major release version of the engine that you want to use. Values |
127
|
|
|
|
|
|
|
depend on the engine that you choose. |
128
|
|
|
|
|
|
|
|
129
|
|
|
|
|
|
|
|
130
|
|
|
|
|
|
|
|
131
|
|
|
|
|
|
|
=head2 B<REQUIRED> InstanceProfileArn => Str |
132
|
|
|
|
|
|
|
|
133
|
|
|
|
|
|
|
The ARN of the instance profile that your Amazon EC2 instances use. |
134
|
|
|
|
|
|
|
Although the AWS OpsWorks console typically creates the instance |
135
|
|
|
|
|
|
|
profile for you, if you are using API commands instead, run the |
136
|
|
|
|
|
|
|
service-role-creation.yaml AWS CloudFormation template, located at |
137
|
|
|
|
|
|
|
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. |
138
|
|
|
|
|
|
|
This template creates a CloudFormation stack that includes the instance |
139
|
|
|
|
|
|
|
profile you need. |
140
|
|
|
|
|
|
|
|
141
|
|
|
|
|
|
|
|
142
|
|
|
|
|
|
|
|
143
|
|
|
|
|
|
|
=head2 B<REQUIRED> InstanceType => Str |
144
|
|
|
|
|
|
|
|
145
|
|
|
|
|
|
|
The Amazon EC2 instance type to use. Valid values must be specified in |
146
|
|
|
|
|
|
|
the following format: C<^([cm][34]|t2).*> For example, C<m4.large>. |
147
|
|
|
|
|
|
|
Valid values are C<t2.medium>, C<m4.large>, or C<m4.2xlarge>. |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
|
150
|
|
|
|
|
|
|
|
151
|
|
|
|
|
|
|
=head2 KeyPair => Str |
152
|
|
|
|
|
|
|
|
153
|
|
|
|
|
|
|
The Amazon EC2 key pair to set for the instance. This parameter is |
154
|
|
|
|
|
|
|
optional; if desired, you may specify this parameter to connect to your |
155
|
|
|
|
|
|
|
instances by using SSH. |
156
|
|
|
|
|
|
|
|
157
|
|
|
|
|
|
|
|
158
|
|
|
|
|
|
|
|
159
|
|
|
|
|
|
|
=head2 PreferredBackupWindow => Str |
160
|
|
|
|
|
|
|
|
161
|
|
|
|
|
|
|
The start time for a one-hour period during which AWS OpsWorks for Chef |
162
|
|
|
|
|
|
|
Automate backs up application-level data on your server if automated |
163
|
|
|
|
|
|
|
backups are enabled. Valid values must be specified in one of the |
164
|
|
|
|
|
|
|
following formats: |
165
|
|
|
|
|
|
|
|
166
|
|
|
|
|
|
|
=over |
167
|
|
|
|
|
|
|
|
168
|
|
|
|
|
|
|
=item * |
169
|
|
|
|
|
|
|
|
170
|
|
|
|
|
|
|
C<HH:MM> for daily backups |
171
|
|
|
|
|
|
|
|
172
|
|
|
|
|
|
|
=item * |
173
|
|
|
|
|
|
|
|
174
|
|
|
|
|
|
|
C<DDD:HH:MM> for weekly backups |
175
|
|
|
|
|
|
|
|
176
|
|
|
|
|
|
|
=back |
177
|
|
|
|
|
|
|
|
178
|
|
|
|
|
|
|
The specified time is in coordinated universal time (UTC). The default |
179
|
|
|
|
|
|
|
value is a random, daily start time. |
180
|
|
|
|
|
|
|
|
181
|
|
|
|
|
|
|
B<Example:> C<08:00>, which represents a daily start time of 08:00 UTC. |
182
|
|
|
|
|
|
|
|
183
|
|
|
|
|
|
|
B<Example:> C<Mon:08:00>, which represents a start time of every Monday |
184
|
|
|
|
|
|
|
at 08:00 UTC. (8:00 a.m.) |
185
|
|
|
|
|
|
|
|
186
|
|
|
|
|
|
|
|
187
|
|
|
|
|
|
|
|
188
|
|
|
|
|
|
|
=head2 PreferredMaintenanceWindow => Str |
189
|
|
|
|
|
|
|
|
190
|
|
|
|
|
|
|
The start time for a one-hour period each week during which AWS |
191
|
|
|
|
|
|
|
OpsWorks for Chef Automate performs maintenance on the instance. Valid |
192
|
|
|
|
|
|
|
values must be specified in the following format: C<DDD:HH:MM>. The |
193
|
|
|
|
|
|
|
specified time is in coordinated universal time (UTC). The default |
194
|
|
|
|
|
|
|
value is a random one-hour period on Tuesday, Wednesday, or Friday. See |
195
|
|
|
|
|
|
|
C<TimeWindowDefinition> for more information. |
196
|
|
|
|
|
|
|
|
197
|
|
|
|
|
|
|
B<Example:> C<Mon:08:00>, which represents a start time of every Monday |
198
|
|
|
|
|
|
|
at 08:00 UTC. (8:00 a.m.) |
199
|
|
|
|
|
|
|
|
200
|
|
|
|
|
|
|
|
201
|
|
|
|
|
|
|
|
202
|
|
|
|
|
|
|
=head2 SecurityGroupIds => ArrayRef[Str|Undef] |
203
|
|
|
|
|
|
|
|
204
|
|
|
|
|
|
|
A list of security group IDs to attach to the Amazon EC2 instance. If |
205
|
|
|
|
|
|
|
you add this parameter, the specified security groups must be within |
206
|
|
|
|
|
|
|
the VPC that is specified by C<SubnetIds>. |
207
|
|
|
|
|
|
|
|
208
|
|
|
|
|
|
|
If you do not specify this parameter, AWS OpsWorks for Chef Automate |
209
|
|
|
|
|
|
|
creates one new security group that uses TCP ports 22 and 443, open to |
210
|
|
|
|
|
|
|
0.0.0.0/0 (everyone). |
211
|
|
|
|
|
|
|
|
212
|
|
|
|
|
|
|
|
213
|
|
|
|
|
|
|
|
214
|
|
|
|
|
|
|
=head2 B<REQUIRED> ServerName => Str |
215
|
|
|
|
|
|
|
|
216
|
|
|
|
|
|
|
The name of the server. The server name must be unique within your AWS |
217
|
|
|
|
|
|
|
account, within each region. Server names must start with a letter; |
218
|
|
|
|
|
|
|
then letters, numbers, or hyphens (-) are allowed, up to a maximum of |
219
|
|
|
|
|
|
|
40 characters. |
220
|
|
|
|
|
|
|
|
221
|
|
|
|
|
|
|
|
222
|
|
|
|
|
|
|
|
223
|
|
|
|
|
|
|
=head2 B<REQUIRED> ServiceRoleArn => Str |
224
|
|
|
|
|
|
|
|
225
|
|
|
|
|
|
|
The service role that the AWS OpsWorks for Chef Automate service |
226
|
|
|
|
|
|
|
backend uses to work with your account. Although the AWS OpsWorks |
227
|
|
|
|
|
|
|
management console typically creates the service role for you, if you |
228
|
|
|
|
|
|
|
are using the AWS CLI or API commands, run the |
229
|
|
|
|
|
|
|
service-role-creation.yaml AWS CloudFormation template, located at |
230
|
|
|
|
|
|
|
https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. |
231
|
|
|
|
|
|
|
This template creates a CloudFormation stack that includes the service |
232
|
|
|
|
|
|
|
role that you need. |
233
|
|
|
|
|
|
|
|
234
|
|
|
|
|
|
|
|
235
|
|
|
|
|
|
|
|
236
|
|
|
|
|
|
|
=head2 SubnetIds => ArrayRef[Str|Undef] |
237
|
|
|
|
|
|
|
|
238
|
|
|
|
|
|
|
The IDs of subnets in which to launch the server EC2 instance. |
239
|
|
|
|
|
|
|
|
240
|
|
|
|
|
|
|
Amazon EC2-Classic customers: This field is required. All servers must |
241
|
|
|
|
|
|
|
run within a VPC. The VPC must have "Auto Assign Public IP" enabled. |
242
|
|
|
|
|
|
|
|
243
|
|
|
|
|
|
|
EC2-VPC customers: This field is optional. If you do not specify subnet |
244
|
|
|
|
|
|
|
IDs, your EC2 instances are created in a default subnet that is |
245
|
|
|
|
|
|
|
selected by Amazon EC2. If you specify subnet IDs, the VPC must have |
246
|
|
|
|
|
|
|
"Auto Assign Public IP" enabled. |
247
|
|
|
|
|
|
|
|
248
|
|
|
|
|
|
|
For more information about supported Amazon EC2 platforms, see |
249
|
|
|
|
|
|
|
Supported Platforms. |
250
|
|
|
|
|
|
|
|
251
|
|
|
|
|
|
|
|
252
|
|
|
|
|
|
|
|
253
|
|
|
|
|
|
|
|
254
|
|
|
|
|
|
|
=head1 SEE ALSO |
255
|
|
|
|
|
|
|
|
256
|
|
|
|
|
|
|
This class forms part of L<Paws>, documenting arguments for method CreateServer in L<Paws::OpsWorksCM> |
257
|
|
|
|
|
|
|
|
258
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
259
|
|
|
|
|
|
|
|
260
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
261
|
|
|
|
|
|
|
|
262
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
263
|
|
|
|
|
|
|
|
264
|
|
|
|
|
|
|
=cut |
265
|
|
|
|
|
|
|
|