aws-sdk-opsworkscm 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
File without changes
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module OpsWorksCM
10
+ module Errors
11
+
12
+ extend Aws::Errors::DynamicErrors
13
+
14
+ # Raised when calling #load or #data on a resource class that can not be
15
+ # loaded. This can happen when:
16
+ #
17
+ # * A resource class has identifiers, but no data attributes.
18
+ # * Resource data is only available when making an API call that
19
+ # enumerates all resources of that type.
20
+ class ResourceNotLoadable < RuntimeError; end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,25 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module OpsWorksCM
10
+ class Resource
11
+
12
+ # @param options ({})
13
+ # @option options [Client] :client
14
+ def initialize(options = {})
15
+ @client = options[:client] || Client.new(options)
16
+ end
17
+
18
+ # @return [Client]
19
+ def client
20
+ @client
21
+ end
22
+
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,1069 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module OpsWorksCM
10
+ module Types
11
+
12
+ # Stores account attributes.
13
+ # @!attribute [rw] name
14
+ # The attribute name. The following are supported attribute names.
15
+ #
16
+ # * *ServerLimit:* The number of servers that currently existing /
17
+ # maximal allowed. By default 10 servers can be created.
18
+ #
19
+ # * *ManualBackupLimit:* The number of manual backups that currently
20
+ # exist / are maximal allowed. By default 50 manual backups can be
21
+ # created.
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] maximum
25
+ # The maximum allowed value.
26
+ # @return [Integer]
27
+ #
28
+ # @!attribute [rw] used
29
+ # The current usage, such as the current number of servers associated
30
+ # with the account.
31
+ # @return [Integer]
32
+ class AccountAttribute < Struct.new(
33
+ :name,
34
+ :maximum,
35
+ :used)
36
+ include Aws::Structure
37
+ end
38
+
39
+ # @note When making an API call, pass AssociateNodeRequest
40
+ # data as a hash:
41
+ #
42
+ # {
43
+ # server_name: "ServerName", # required
44
+ # node_name: "NodeName", # required
45
+ # engine_attributes: [
46
+ # {
47
+ # name: "String",
48
+ # value: "String",
49
+ # },
50
+ # ],
51
+ # }
52
+ # @!attribute [rw] server_name
53
+ # @return [String]
54
+ #
55
+ # @!attribute [rw] node_name
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] engine_attributes
59
+ # @return [Array<Types::EngineAttribute>]
60
+ class AssociateNodeRequest < Struct.new(
61
+ :server_name,
62
+ :node_name,
63
+ :engine_attributes)
64
+ include Aws::Structure
65
+ end
66
+
67
+ # @!attribute [rw] node_association_status_token
68
+ # @return [String]
69
+ class AssociateNodeResponse < Struct.new(
70
+ :node_association_status_token)
71
+ include Aws::Structure
72
+ end
73
+
74
+ # Describes a single backup.
75
+ # @!attribute [rw] backup_arn
76
+ # The ARN of the backup.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] backup_id
80
+ # The generated ID of the backup. Example:
81
+ # `myServerName-yyyyMMddHHmmssSSS`
82
+ # @return [String]
83
+ #
84
+ # @!attribute [rw] backup_type
85
+ # The backup type. Valid values are `automated` or `manual`.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] created_at
89
+ # The time stamp when the backup was created in the database. Example:
90
+ # `2016-07-29T13:38:47.520Z`
91
+ # @return [Time]
92
+ #
93
+ # @!attribute [rw] description
94
+ # A user-provided description for a manual backup. This field is empty
95
+ # for automated backups.
96
+ # @return [String]
97
+ #
98
+ # @!attribute [rw] engine
99
+ # The engine type that is obtained from the server when the backup is
100
+ # created.
101
+ # @return [String]
102
+ #
103
+ # @!attribute [rw] engine_model
104
+ # The engine model that is obtained from the server when the backup is
105
+ # created.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] engine_version
109
+ # The engine version that is obtained from the server when the backup
110
+ # is created.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] instance_profile_arn
114
+ # The EC2 instance profile ARN that is obtained from the server when
115
+ # the backup is created. Because this value is stored, you are not
116
+ # required to provide the InstanceProfileArn again if you restore a
117
+ # backup.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] instance_type
121
+ # The instance type that is obtained from the server when the backup
122
+ # is created.
123
+ # @return [String]
124
+ #
125
+ # @!attribute [rw] key_pair
126
+ # The key pair that is obtained from the server when the backup is
127
+ # created.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] preferred_backup_window
131
+ # The preferred backup period that is obtained from the server when
132
+ # the backup is created.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] preferred_maintenance_window
136
+ # The preferred maintenance period that is obtained from the server
137
+ # when the backup is created.
138
+ # @return [String]
139
+ #
140
+ # @!attribute [rw] s3_data_size
141
+ # The size of the backup, in bytes. The size is returned by the
142
+ # instance in the command results.
143
+ # @return [Integer]
144
+ #
145
+ # @!attribute [rw] s3_data_url
146
+ # The Amazon S3 URL of the backup's tar.gz file.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] s3_log_url
150
+ # The Amazon S3 URL of the backup's log file.
151
+ # @return [String]
152
+ #
153
+ # @!attribute [rw] security_group_ids
154
+ # The security group IDs that are obtained from the server when the
155
+ # backup is created.
156
+ # @return [Array<String>]
157
+ #
158
+ # @!attribute [rw] server_name
159
+ # The name of the server from which the backup was made.
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] service_role_arn
163
+ # The service role ARN that is obtained from the server when the
164
+ # backup is created.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] status
168
+ # The status of a backup while in progress.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] status_description
172
+ # An informational message about backup status.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] subnet_ids
176
+ # The subnet IDs that are obtained from the server when the backup is
177
+ # created.
178
+ # @return [Array<String>]
179
+ #
180
+ # @!attribute [rw] tools_version
181
+ # The version of AWS OpsWorks for Chef Automate-specific tools that is
182
+ # obtained from the server when the backup is created.
183
+ # @return [String]
184
+ #
185
+ # @!attribute [rw] user_arn
186
+ # The IAM user ARN of the requester for manual backups. This field is
187
+ # empty for automated backups.
188
+ # @return [String]
189
+ class Backup < Struct.new(
190
+ :backup_arn,
191
+ :backup_id,
192
+ :backup_type,
193
+ :created_at,
194
+ :description,
195
+ :engine,
196
+ :engine_model,
197
+ :engine_version,
198
+ :instance_profile_arn,
199
+ :instance_type,
200
+ :key_pair,
201
+ :preferred_backup_window,
202
+ :preferred_maintenance_window,
203
+ :s3_data_size,
204
+ :s3_data_url,
205
+ :s3_log_url,
206
+ :security_group_ids,
207
+ :server_name,
208
+ :service_role_arn,
209
+ :status,
210
+ :status_description,
211
+ :subnet_ids,
212
+ :tools_version,
213
+ :user_arn)
214
+ include Aws::Structure
215
+ end
216
+
217
+ # @note When making an API call, pass CreateBackupRequest
218
+ # data as a hash:
219
+ #
220
+ # {
221
+ # server_name: "ServerName", # required
222
+ # description: "String",
223
+ # }
224
+ # @!attribute [rw] server_name
225
+ # The name of the server that you want to back up.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] description
229
+ # A user-defined description of the backup.
230
+ # @return [String]
231
+ class CreateBackupRequest < Struct.new(
232
+ :server_name,
233
+ :description)
234
+ include Aws::Structure
235
+ end
236
+
237
+ # @!attribute [rw] backup
238
+ # Backup created by request.
239
+ # @return [Types::Backup]
240
+ class CreateBackupResponse < Struct.new(
241
+ :backup)
242
+ include Aws::Structure
243
+ end
244
+
245
+ # @note When making an API call, pass CreateServerRequest
246
+ # data as a hash:
247
+ #
248
+ # {
249
+ # disable_automated_backup: false,
250
+ # engine: "String",
251
+ # engine_model: "String",
252
+ # engine_version: "String",
253
+ # engine_attributes: [
254
+ # {
255
+ # name: "String",
256
+ # value: "String",
257
+ # },
258
+ # ],
259
+ # backup_retention_count: 1,
260
+ # server_name: "ServerName", # required
261
+ # instance_profile_arn: "InstanceProfileArn", # required
262
+ # instance_type: "String",
263
+ # key_pair: "KeyPair",
264
+ # preferred_maintenance_window: "TimeWindowDefinition",
265
+ # preferred_backup_window: "TimeWindowDefinition",
266
+ # security_group_ids: ["String"],
267
+ # service_role_arn: "ServiceRoleArn", # required
268
+ # subnet_ids: ["String"],
269
+ # backup_id: "BackupId",
270
+ # }
271
+ # @!attribute [rw] disable_automated_backup
272
+ # Enable or disable scheduled backups. Valid values are `true` or
273
+ # `false`. The default value is `true`.
274
+ # @return [Boolean]
275
+ #
276
+ # @!attribute [rw] engine
277
+ # The configuration management engine to use. Valid values include
278
+ # `Chef`.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] engine_model
282
+ # The engine model, or option. Valid values include `Single`.
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] engine_version
286
+ # The major release version of the engine that you want to use. Values
287
+ # depend on the engine that you choose.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] engine_attributes
291
+ # Engine attributes on a specified server.
292
+ #
293
+ # **Attributes accepted in a createServer request:**
294
+ #
295
+ # * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is not
296
+ # stored by AWS OpsWorks for Chef Automate. This private key is
297
+ # required to access the Chef API.
298
+ #
299
+ # ^
300
+ # @return [Array<Types::EngineAttribute>]
301
+ #
302
+ # @!attribute [rw] backup_retention_count
303
+ # The number of automated backups that you want to keep. Whenever a
304
+ # new backup is created, AWS OpsWorks for Chef Automate deletes the
305
+ # oldest backups if this number is exceeded. The default value is `1`.
306
+ # @return [Integer]
307
+ #
308
+ # @!attribute [rw] server_name
309
+ # The name of the server. The server name must be unique within your
310
+ # AWS account, within each region. Server names must start with a
311
+ # letter; then letters, numbers, or hyphens (-) are allowed, up to a
312
+ # maximum of 32 characters.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] instance_profile_arn
316
+ # The ARN of the instance profile that your Amazon EC2 instances use.
317
+ # Although the AWS OpsWorks console typically creates the instance
318
+ # profile for you, in this release of AWS OpsWorks for Chef Automate,
319
+ # run the service-role-creation.yaml AWS CloudFormation template,
320
+ # located at
321
+ # https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
322
+ # This template creates a stack that includes the instance profile you
323
+ # need.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] instance_type
327
+ # The Amazon EC2 instance type to use. Valid values must be specified
328
+ # in the following format: `^([cm][34]|t2).*` For example, `c3.large`.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] key_pair
332
+ # The Amazon EC2 key pair to set for the instance. You may specify
333
+ # this parameter to connect to your instances by using SSH.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] preferred_maintenance_window
337
+ # The start time for a one-hour period each week during which AWS
338
+ # OpsWorks for Chef Automate performs maintenance on the instance.
339
+ # Valid values must be specified in the following format: `DDD:HH:MM`.
340
+ # The specified time is in coordinated universal time (UTC). The
341
+ # default value is a random one-hour period on Tuesday, Wednesday, or
342
+ # Friday. See `TimeWindowDefinition` for more information.
343
+ #
344
+ # **Example:** `Mon:08:00`, which represents a start time of every
345
+ # Monday at 08:00 UTC. (8:00 a.m.)
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] preferred_backup_window
349
+ # The start time for a one-hour period during which AWS OpsWorks for
350
+ # Chef Automate backs up application-level data on your server if
351
+ # backups are enabled. Valid values must be specified in one of the
352
+ # following formats:
353
+ #
354
+ # * `HH:MM` for daily backups
355
+ #
356
+ # * `DDD:HH:MM` for weekly backups
357
+ #
358
+ # The specified time is in coordinated universal time (UTC). The
359
+ # default value is a random, daily start time.
360
+ #
361
+ # **Example:** `08:00`, which represents a daily start time of 08:00
362
+ # UTC.
363
+ #
364
+ # **Example:** `Mon:08:00`, which represents a start time of every
365
+ # Monday at 08:00 UTC. (8:00 a.m.)
366
+ # @return [String]
367
+ #
368
+ # @!attribute [rw] security_group_ids
369
+ # A list of security group IDs to attach to the Amazon EC2 instance.
370
+ # If you add this parameter, the specified security groups must be
371
+ # within the VPC that is specified by `SubnetIds`.
372
+ #
373
+ # If you do not specify this parameter, AWS OpsWorks for Chef Automate
374
+ # creates one new security group that uses TCP ports 22 and 443, open
375
+ # to 0.0.0.0/0 (everyone).
376
+ # @return [Array<String>]
377
+ #
378
+ # @!attribute [rw] service_role_arn
379
+ # The service role that the AWS OpsWorks for Chef Automate service
380
+ # backend uses to work with your account. Although the AWS OpsWorks
381
+ # console typically creates the service role for you, in this release
382
+ # of AWS OpsWorks for Chef Automate, run the
383
+ # service-role-creation.yaml AWS CloudFormation template, located at
384
+ # https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml.
385
+ # This template creates a stack that includes the service role that
386
+ # you need.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] subnet_ids
390
+ # The IDs of subnets in which to launch the server EC2 instance.
391
+ #
392
+ # Amazon EC2-Classic customers: This field is required. All servers
393
+ # must run within a VPC. The VPC must have "Auto Assign Public IP"
394
+ # enabled.
395
+ #
396
+ # EC2-VPC customers: This field is optional. If you do not specify
397
+ # subnet IDs, your EC2 instances are created in a default subnet that
398
+ # is selected by Amazon EC2. If you specify subnet IDs, the VPC must
399
+ # have "Auto Assign Public IP" enabled.
400
+ #
401
+ # For more information about supported Amazon EC2 platforms, see
402
+ # [Supported Platforms][1].
403
+ #
404
+ #
405
+ #
406
+ # [1]: http://docs.aws.amazon.com/https:/docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
407
+ # @return [Array<String>]
408
+ #
409
+ # @!attribute [rw] backup_id
410
+ # If you specify this field, AWS OpsWorks for Chef Automate creates
411
+ # the server by using the backup represented by BackupId.
412
+ # @return [String]
413
+ class CreateServerRequest < Struct.new(
414
+ :disable_automated_backup,
415
+ :engine,
416
+ :engine_model,
417
+ :engine_version,
418
+ :engine_attributes,
419
+ :backup_retention_count,
420
+ :server_name,
421
+ :instance_profile_arn,
422
+ :instance_type,
423
+ :key_pair,
424
+ :preferred_maintenance_window,
425
+ :preferred_backup_window,
426
+ :security_group_ids,
427
+ :service_role_arn,
428
+ :subnet_ids,
429
+ :backup_id)
430
+ include Aws::Structure
431
+ end
432
+
433
+ # @!attribute [rw] server
434
+ # The server that is created by the request.
435
+ # @return [Types::Server]
436
+ class CreateServerResponse < Struct.new(
437
+ :server)
438
+ include Aws::Structure
439
+ end
440
+
441
+ # @note When making an API call, pass DeleteBackupRequest
442
+ # data as a hash:
443
+ #
444
+ # {
445
+ # backup_id: "BackupId", # required
446
+ # }
447
+ # @!attribute [rw] backup_id
448
+ # The ID of the backup to delete. Run the DescribeBackups command to
449
+ # get a list of backup IDs. Backup IDs are in the format
450
+ # `ServerName-yyyyMMddHHmmssSSS`.
451
+ # @return [String]
452
+ class DeleteBackupRequest < Struct.new(
453
+ :backup_id)
454
+ include Aws::Structure
455
+ end
456
+
457
+ class DeleteBackupResponse < Aws::EmptyStructure; end
458
+
459
+ # @note When making an API call, pass DeleteServerRequest
460
+ # data as a hash:
461
+ #
462
+ # {
463
+ # server_name: "ServerName", # required
464
+ # }
465
+ # @!attribute [rw] server_name
466
+ # The ID of the server to delete.
467
+ # @return [String]
468
+ class DeleteServerRequest < Struct.new(
469
+ :server_name)
470
+ include Aws::Structure
471
+ end
472
+
473
+ class DeleteServerResponse < Aws::EmptyStructure; end
474
+
475
+ # @api private
476
+ class DescribeAccountAttributesRequest < Aws::EmptyStructure; end
477
+
478
+ # @!attribute [rw] attributes
479
+ # The attributes that are currently set for the account.
480
+ # @return [Array<Types::AccountAttribute>]
481
+ class DescribeAccountAttributesResponse < Struct.new(
482
+ :attributes)
483
+ include Aws::Structure
484
+ end
485
+
486
+ # @note When making an API call, pass DescribeBackupsRequest
487
+ # data as a hash:
488
+ #
489
+ # {
490
+ # backup_id: "BackupId",
491
+ # server_name: "ServerName",
492
+ # next_token: "NextToken",
493
+ # max_results: 1,
494
+ # }
495
+ # @!attribute [rw] backup_id
496
+ # Describes a single backup.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] server_name
500
+ # Returns backups for the server with the specified ServerName.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] next_token
504
+ # NextToken is a string that is returned in some command responses. It
505
+ # indicates that not all entries have been returned, and that you must
506
+ # run at least one more request to get remaining items. To get
507
+ # remaining results, call `DescribeBackups` again, and assign the
508
+ # token from the previous results as the value of the `nextToken`
509
+ # parameter. If there are no more results, the response object's
510
+ # `nextToken` parameter value is `null`. Setting a `nextToken` value
511
+ # that was not returned in your previous results causes an
512
+ # `InvalidNextTokenException` to occur.
513
+ # @return [String]
514
+ #
515
+ # @!attribute [rw] max_results
516
+ # To receive a paginated response, use this parameter to specify the
517
+ # maximum number of results to be returned with a single call. If the
518
+ # number of available results exceeds this maximum, the response
519
+ # includes a `NextToken` value that you can assign to the `NextToken`
520
+ # request parameter to get the next set of results.
521
+ # @return [Integer]
522
+ class DescribeBackupsRequest < Struct.new(
523
+ :backup_id,
524
+ :server_name,
525
+ :next_token,
526
+ :max_results)
527
+ include Aws::Structure
528
+ end
529
+
530
+ # @!attribute [rw] backups
531
+ # Contains the response to a `DescribeBackups` request.
532
+ # @return [Array<Types::Backup>]
533
+ #
534
+ # @!attribute [rw] next_token
535
+ # NextToken is a string that is returned in some command responses. It
536
+ # indicates that not all entries have been returned, and that you must
537
+ # run at least one more request to get remaining items. To get
538
+ # remaining results, call `DescribeBackups` again, and assign the
539
+ # token from the previous results as the value of the `nextToken`
540
+ # parameter. If there are no more results, the response object's
541
+ # `nextToken` parameter value is `null`. Setting a `nextToken` value
542
+ # that was not returned in your previous results causes an
543
+ # `InvalidNextTokenException` to occur.
544
+ # @return [String]
545
+ class DescribeBackupsResponse < Struct.new(
546
+ :backups,
547
+ :next_token)
548
+ include Aws::Structure
549
+ end
550
+
551
+ # @note When making an API call, pass DescribeEventsRequest
552
+ # data as a hash:
553
+ #
554
+ # {
555
+ # server_name: "ServerName", # required
556
+ # next_token: "NextToken",
557
+ # max_results: 1,
558
+ # }
559
+ # @!attribute [rw] server_name
560
+ # The name of the server for which you want to view events.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] next_token
564
+ # NextToken is a string that is returned in some command responses. It
565
+ # indicates that not all entries have been returned, and that you must
566
+ # run at least one more request to get remaining items. To get
567
+ # remaining results, call `DescribeEvents` again, and assign the token
568
+ # from the previous results as the value of the `nextToken` parameter.
569
+ # If there are no more results, the response object's `nextToken`
570
+ # parameter value is `null`. Setting a `nextToken` value that was not
571
+ # returned in your previous results causes an
572
+ # `InvalidNextTokenException` to occur.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] max_results
576
+ # To receive a paginated response, use this parameter to specify the
577
+ # maximum number of results to be returned with a single call. If the
578
+ # number of available results exceeds this maximum, the response
579
+ # includes a `NextToken` value that you can assign to the `NextToken`
580
+ # request parameter to get the next set of results.
581
+ # @return [Integer]
582
+ class DescribeEventsRequest < Struct.new(
583
+ :server_name,
584
+ :next_token,
585
+ :max_results)
586
+ include Aws::Structure
587
+ end
588
+
589
+ # @!attribute [rw] server_events
590
+ # Contains the response to a `DescribeEvents` request.
591
+ # @return [Array<Types::ServerEvent>]
592
+ #
593
+ # @!attribute [rw] next_token
594
+ # NextToken is a string that is returned in some command responses. It
595
+ # indicates that not all entries have been returned, and that you must
596
+ # run at least one more request to get remaining items. To get
597
+ # remaining results, call `DescribeEvents` again, and assign the token
598
+ # from the previous results as the value of the `nextToken` parameter.
599
+ # If there are no more results, the response object's `nextToken`
600
+ # parameter value is `null`. Setting a `nextToken` value that was not
601
+ # returned in your previous results causes an
602
+ # `InvalidNextTokenException` to occur.
603
+ # @return [String]
604
+ class DescribeEventsResponse < Struct.new(
605
+ :server_events,
606
+ :next_token)
607
+ include Aws::Structure
608
+ end
609
+
610
+ # @note When making an API call, pass DescribeNodeAssociationStatusRequest
611
+ # data as a hash:
612
+ #
613
+ # {
614
+ # node_association_status_token: "NodeAssociationStatusToken", # required
615
+ # server_name: "ServerName", # required
616
+ # }
617
+ # @!attribute [rw] node_association_status_token
618
+ # @return [String]
619
+ #
620
+ # @!attribute [rw] server_name
621
+ # @return [String]
622
+ class DescribeNodeAssociationStatusRequest < Struct.new(
623
+ :node_association_status_token,
624
+ :server_name)
625
+ include Aws::Structure
626
+ end
627
+
628
+ # @!attribute [rw] node_association_status
629
+ # @return [String]
630
+ class DescribeNodeAssociationStatusResponse < Struct.new(
631
+ :node_association_status)
632
+ include Aws::Structure
633
+ end
634
+
635
+ # @note When making an API call, pass DescribeServersRequest
636
+ # data as a hash:
637
+ #
638
+ # {
639
+ # server_name: "ServerName",
640
+ # next_token: "NextToken",
641
+ # max_results: 1,
642
+ # }
643
+ # @!attribute [rw] server_name
644
+ # Describes the server with the specified ServerName.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] next_token
648
+ # NextToken is a string that is returned in some command responses. It
649
+ # indicates that not all entries have been returned, and that you must
650
+ # run at least one more request to get remaining items. To get
651
+ # remaining results, call `DescribeServers` again, and assign the
652
+ # token from the previous results as the value of the `nextToken`
653
+ # parameter. If there are no more results, the response object's
654
+ # `nextToken` parameter value is `null`. Setting a `nextToken` value
655
+ # that was not returned in your previous results causes an
656
+ # `InvalidNextTokenException` to occur.
657
+ # @return [String]
658
+ #
659
+ # @!attribute [rw] max_results
660
+ # To receive a paginated response, use this parameter to specify the
661
+ # maximum number of results to be returned with a single call. If the
662
+ # number of available results exceeds this maximum, the response
663
+ # includes a `NextToken` value that you can assign to the `NextToken`
664
+ # request parameter to get the next set of results.
665
+ # @return [Integer]
666
+ class DescribeServersRequest < Struct.new(
667
+ :server_name,
668
+ :next_token,
669
+ :max_results)
670
+ include Aws::Structure
671
+ end
672
+
673
+ # @!attribute [rw] servers
674
+ # Contains the response to a `DescribeServers` request.
675
+ # @return [Array<Types::Server>]
676
+ #
677
+ # @!attribute [rw] next_token
678
+ # NextToken is a string that is returned in some command responses. It
679
+ # indicates that not all entries have been returned, and that you must
680
+ # run at least one more request to get remaining items. To get
681
+ # remaining results, call `DescribeServers` again, and assign the
682
+ # token from the previous results as the value of the `nextToken`
683
+ # parameter. If there are no more results, the response object's
684
+ # `nextToken` parameter value is `null`. Setting a `nextToken` value
685
+ # that was not returned in your previous results causes an
686
+ # `InvalidNextTokenException` to occur.
687
+ # @return [String]
688
+ class DescribeServersResponse < Struct.new(
689
+ :servers,
690
+ :next_token)
691
+ include Aws::Structure
692
+ end
693
+
694
+ # @note When making an API call, pass DisassociateNodeRequest
695
+ # data as a hash:
696
+ #
697
+ # {
698
+ # server_name: "ServerName", # required
699
+ # node_name: "NodeName", # required
700
+ # engine_attributes: [
701
+ # {
702
+ # name: "String",
703
+ # value: "String",
704
+ # },
705
+ # ],
706
+ # }
707
+ # @!attribute [rw] server_name
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] node_name
711
+ # @return [String]
712
+ #
713
+ # @!attribute [rw] engine_attributes
714
+ # @return [Array<Types::EngineAttribute>]
715
+ class DisassociateNodeRequest < Struct.new(
716
+ :server_name,
717
+ :node_name,
718
+ :engine_attributes)
719
+ include Aws::Structure
720
+ end
721
+
722
+ # @!attribute [rw] node_association_status_token
723
+ # @return [String]
724
+ class DisassociateNodeResponse < Struct.new(
725
+ :node_association_status_token)
726
+ include Aws::Structure
727
+ end
728
+
729
+ # A name/value pair that is specific to the engine of the server.
730
+ # @note When making an API call, pass EngineAttribute
731
+ # data as a hash:
732
+ #
733
+ # {
734
+ # name: "String",
735
+ # value: "String",
736
+ # }
737
+ # @!attribute [rw] name
738
+ # The name of the engine attribute.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] value
742
+ # The value of the engine attribute.
743
+ # @return [String]
744
+ class EngineAttribute < Struct.new(
745
+ :name,
746
+ :value)
747
+ include Aws::Structure
748
+ end
749
+
750
+ # @note When making an API call, pass RestoreServerRequest
751
+ # data as a hash:
752
+ #
753
+ # {
754
+ # backup_id: "BackupId", # required
755
+ # server_name: "ServerName", # required
756
+ # instance_type: "String",
757
+ # key_pair: "KeyPair",
758
+ # }
759
+ # @!attribute [rw] backup_id
760
+ # The ID of the backup that you want to use to restore a server.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] server_name
764
+ # The name of the server that you want to restore.
765
+ # @return [String]
766
+ #
767
+ # @!attribute [rw] instance_type
768
+ # The type of the instance to create. Valid values must be specified
769
+ # in the following format: `^([cm][34]|t2).*` For example, `c3.large`.
770
+ # If you do not specify this parameter, RestoreServer uses the
771
+ # instance type from the specified backup.
772
+ # @return [String]
773
+ #
774
+ # @!attribute [rw] key_pair
775
+ # The name of the key pair to set on the new EC2 instance. This can be
776
+ # helpful if any of the administrators who manage the server no longer
777
+ # have the SSH key.
778
+ # @return [String]
779
+ class RestoreServerRequest < Struct.new(
780
+ :backup_id,
781
+ :server_name,
782
+ :instance_type,
783
+ :key_pair)
784
+ include Aws::Structure
785
+ end
786
+
787
+ class RestoreServerResponse < Aws::EmptyStructure; end
788
+
789
+ # Describes a configuration management server.
790
+ # @!attribute [rw] backup_retention_count
791
+ # The number of automated backups to keep.
792
+ # @return [Integer]
793
+ #
794
+ # @!attribute [rw] server_name
795
+ # The name of the server.
796
+ # @return [String]
797
+ #
798
+ # @!attribute [rw] created_at
799
+ # Time stamp of server creation. Example `2016-07-29T13:38:47.520Z`
800
+ # @return [Time]
801
+ #
802
+ # @!attribute [rw] disable_automated_backup
803
+ # Disables automated backups. The number of stored backups is
804
+ # dependent on the value of PreferredBackupCount.
805
+ # @return [Boolean]
806
+ #
807
+ # @!attribute [rw] endpoint
808
+ # A DNS name that can be used to access the engine. Example:
809
+ # `myserver-asdfghjkl.us-east-1.opsworks.io`
810
+ # @return [String]
811
+ #
812
+ # @!attribute [rw] engine
813
+ # The engine type of the server. The valid value in this release is
814
+ # `Chef`.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] engine_model
818
+ # The engine model of the server. The valid value in this release is
819
+ # `Single`.
820
+ # @return [String]
821
+ #
822
+ # @!attribute [rw] engine_attributes
823
+ # The response of a createServer() request returns the master
824
+ # credential to access the server in EngineAttributes. These
825
+ # credentials are not stored by AWS OpsWorks for Chef Automate; they
826
+ # are returned only as part of the result of createServer().
827
+ #
828
+ # **Attributes returned in a createServer response:**
829
+ #
830
+ # * `CHEF_PIVOTAL_KEY`\: A base64-encoded RSA private key that is
831
+ # generated by AWS OpsWorks for Chef Automate. This private key is
832
+ # required to access the Chef API.
833
+ #
834
+ # * `CHEF_STARTER_KIT`\: A base64-encoded ZIP file. The ZIP file
835
+ # contains a Chef starter kit, which includes a README, a
836
+ # configuration file, and the required RSA private key. Save this
837
+ # file, unzip it, and then change to the directory where you've
838
+ # unzipped the file contents. From this directory, you can run Knife
839
+ # commands.
840
+ # @return [Array<Types::EngineAttribute>]
841
+ #
842
+ # @!attribute [rw] engine_version
843
+ # The engine version of the server. Because Chef is the engine
844
+ # available in this release, the valid value for EngineVersion is
845
+ # `12`.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] instance_profile_arn
849
+ # The instance profile ARN of the server.
850
+ # @return [String]
851
+ #
852
+ # @!attribute [rw] instance_type
853
+ # The instance type for the server, as specified in the CloudFormation
854
+ # stack. This might not be the same instance type that is shown in the
855
+ # EC2 console.
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] key_pair
859
+ # The key pair associated with the server.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] maintenance_status
863
+ # The status of the most recent server maintenance run. Shows
864
+ # `SUCCESS` or `FAILED`.
865
+ # @return [String]
866
+ #
867
+ # @!attribute [rw] preferred_maintenance_window
868
+ # The preferred maintenance period specified for the server.
869
+ # @return [String]
870
+ #
871
+ # @!attribute [rw] preferred_backup_window
872
+ # The preferred backup period specified for the server.
873
+ # @return [String]
874
+ #
875
+ # @!attribute [rw] security_group_ids
876
+ # The security group IDs for the server, as specified in the
877
+ # CloudFormation stack. These might not be the same security groups
878
+ # that are shown in the EC2 console.
879
+ # @return [Array<String>]
880
+ #
881
+ # @!attribute [rw] service_role_arn
882
+ # The service role ARN used to create the server.
883
+ # @return [String]
884
+ #
885
+ # @!attribute [rw] status
886
+ # The server's status. This field displays the states of actions in
887
+ # progress, such as creating, running, or backing up the server, as
888
+ # well as server health.
889
+ # @return [String]
890
+ #
891
+ # @!attribute [rw] status_reason
892
+ # Depending on the server status, this field has either a
893
+ # human-readable message (such as a create or backup error), or an
894
+ # escaped block of JSON (used for health check results).
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] subnet_ids
898
+ # The subnet IDs specified in a CreateServer request.
899
+ # @return [Array<String>]
900
+ #
901
+ # @!attribute [rw] server_arn
902
+ # The ARN of the server.
903
+ # @return [String]
904
+ class Server < Struct.new(
905
+ :backup_retention_count,
906
+ :server_name,
907
+ :created_at,
908
+ :disable_automated_backup,
909
+ :endpoint,
910
+ :engine,
911
+ :engine_model,
912
+ :engine_attributes,
913
+ :engine_version,
914
+ :instance_profile_arn,
915
+ :instance_type,
916
+ :key_pair,
917
+ :maintenance_status,
918
+ :preferred_maintenance_window,
919
+ :preferred_backup_window,
920
+ :security_group_ids,
921
+ :service_role_arn,
922
+ :status,
923
+ :status_reason,
924
+ :subnet_ids,
925
+ :server_arn)
926
+ include Aws::Structure
927
+ end
928
+
929
+ # An event that is related to the server, such as the start of
930
+ # maintenance or backup.
931
+ # @!attribute [rw] created_at
932
+ # The time when the event occurred.
933
+ # @return [Time]
934
+ #
935
+ # @!attribute [rw] server_name
936
+ # The name of the server on or for which the event occurred.
937
+ # @return [String]
938
+ #
939
+ # @!attribute [rw] message
940
+ # A human-readable informational or status message.
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] log_url
944
+ # The Amazon S3 URL of the event's log file.
945
+ # @return [String]
946
+ class ServerEvent < Struct.new(
947
+ :created_at,
948
+ :server_name,
949
+ :message,
950
+ :log_url)
951
+ include Aws::Structure
952
+ end
953
+
954
+ # @note When making an API call, pass StartMaintenanceRequest
955
+ # data as a hash:
956
+ #
957
+ # {
958
+ # server_name: "ServerName", # required
959
+ # }
960
+ # @!attribute [rw] server_name
961
+ # The name of the server on which to run maintenance.
962
+ # @return [String]
963
+ class StartMaintenanceRequest < Struct.new(
964
+ :server_name)
965
+ include Aws::Structure
966
+ end
967
+
968
+ # @!attribute [rw] server
969
+ # Contains the response to a `StartMaintenance` request.
970
+ # @return [Types::Server]
971
+ class StartMaintenanceResponse < Struct.new(
972
+ :server)
973
+ include Aws::Structure
974
+ end
975
+
976
+ # @note When making an API call, pass UpdateServerEngineAttributesRequest
977
+ # data as a hash:
978
+ #
979
+ # {
980
+ # server_name: "ServerName", # required
981
+ # attribute_name: "AttributeName", # required
982
+ # attribute_value: "AttributeValue",
983
+ # }
984
+ # @!attribute [rw] server_name
985
+ # The name of the server to update.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] attribute_name
989
+ # The name of the engine attribute to update.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] attribute_value
993
+ # The value to set for the attribute.
994
+ # @return [String]
995
+ class UpdateServerEngineAttributesRequest < Struct.new(
996
+ :server_name,
997
+ :attribute_name,
998
+ :attribute_value)
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # @!attribute [rw] server
1003
+ # Contains the response to an `UpdateServerEngineAttributes` request.
1004
+ # @return [Types::Server]
1005
+ class UpdateServerEngineAttributesResponse < Struct.new(
1006
+ :server)
1007
+ include Aws::Structure
1008
+ end
1009
+
1010
+ # @note When making an API call, pass UpdateServerRequest
1011
+ # data as a hash:
1012
+ #
1013
+ # {
1014
+ # disable_automated_backup: false,
1015
+ # backup_retention_count: 1,
1016
+ # server_name: "ServerName", # required
1017
+ # preferred_maintenance_window: "TimeWindowDefinition",
1018
+ # preferred_backup_window: "TimeWindowDefinition",
1019
+ # }
1020
+ # @!attribute [rw] disable_automated_backup
1021
+ # Setting DisableAutomatedBackup to `true` disables automated or
1022
+ # scheduled backups. Automated backups are enabled by default.
1023
+ # @return [Boolean]
1024
+ #
1025
+ # @!attribute [rw] backup_retention_count
1026
+ # Sets the number of automated backups that you want to keep.
1027
+ # @return [Integer]
1028
+ #
1029
+ # @!attribute [rw] server_name
1030
+ # The name of the server to update.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] preferred_maintenance_window
1034
+ # `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
1035
+ #
1036
+ # Time windows always use coordinated universal time (UTC).
1037
+ #
1038
+ # Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
1039
+ # Sat, Sun.
1040
+ # @return [String]
1041
+ #
1042
+ # @!attribute [rw] preferred_backup_window
1043
+ # `DDD:HH:MM` (weekly start time) or `HH:MM` (daily start time).
1044
+ #
1045
+ # Time windows always use coordinated universal time (UTC).
1046
+ #
1047
+ # Valid strings for day of week (`DDD`) are: Mon, Tue, Wed, Thr, Fri,
1048
+ # Sat, Sun.
1049
+ # @return [String]
1050
+ class UpdateServerRequest < Struct.new(
1051
+ :disable_automated_backup,
1052
+ :backup_retention_count,
1053
+ :server_name,
1054
+ :preferred_maintenance_window,
1055
+ :preferred_backup_window)
1056
+ include Aws::Structure
1057
+ end
1058
+
1059
+ # @!attribute [rw] server
1060
+ # Contains the response to a `UpdateServer` request.
1061
+ # @return [Types::Server]
1062
+ class UpdateServerResponse < Struct.new(
1063
+ :server)
1064
+ include Aws::Structure
1065
+ end
1066
+
1067
+ end
1068
+ end
1069
+ end