aws-sdk-sms 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,46 +8,134 @@
8
8
  module Aws::SMS
9
9
  module Types
10
10
 
11
- # Object representing a Connector
11
+ # Information about the application.
12
+ #
13
+ # @!attribute [rw] app_id
14
+ # Unique ID of the application.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] name
18
+ # Name of the application.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] description
22
+ # Description of the application.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] status
26
+ # Status of the application.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] status_message
30
+ # A message related to the status of the application
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] replication_status
34
+ # Replication status of the application.
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] replication_status_message
38
+ # A message related to the replication status of the application.
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] latest_replication_time
42
+ # Timestamp of the application's most recent successful replication.
43
+ # @return [Time]
44
+ #
45
+ # @!attribute [rw] launch_status
46
+ # Launch status of the application.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] launch_status_message
50
+ # A message related to the launch status of the application.
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] launch_details
54
+ # Details about the latest launch of the application.
55
+ # @return [Types::LaunchDetails]
56
+ #
57
+ # @!attribute [rw] creation_time
58
+ # Time of creation of this application.
59
+ # @return [Time]
60
+ #
61
+ # @!attribute [rw] last_modified
62
+ # Timestamp of the application's creation.
63
+ # @return [Time]
64
+ #
65
+ # @!attribute [rw] role_name
66
+ # Name of the service role in the customer's account used by AWS SMS.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] total_server_groups
70
+ # Number of server groups present in the application.
71
+ # @return [Integer]
72
+ #
73
+ # @!attribute [rw] total_servers
74
+ # Number of servers present in the application.
75
+ # @return [Integer]
76
+ #
77
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/AppSummary AWS API Documentation
78
+ #
79
+ class AppSummary < Struct.new(
80
+ :app_id,
81
+ :name,
82
+ :description,
83
+ :status,
84
+ :status_message,
85
+ :replication_status,
86
+ :replication_status_message,
87
+ :latest_replication_time,
88
+ :launch_status,
89
+ :launch_status_message,
90
+ :launch_details,
91
+ :creation_time,
92
+ :last_modified,
93
+ :role_name,
94
+ :total_server_groups,
95
+ :total_servers)
96
+ include Aws::Structure
97
+ end
98
+
99
+ # Represents a connector.
12
100
  #
13
101
  # @!attribute [rw] connector_id
14
- # Unique Identifier for Connector
102
+ # The identifier of the connector.
15
103
  # @return [String]
16
104
  #
17
105
  # @!attribute [rw] version
18
- # Connector version string
106
+ # The connector version.
19
107
  # @return [String]
20
108
  #
21
109
  # @!attribute [rw] status
22
- # Status of on-premise Connector
110
+ # The status of the connector.
23
111
  # @return [String]
24
112
  #
25
113
  # @!attribute [rw] capability_list
26
- # List of Connector Capabilities
114
+ # The capabilities of the connector.
27
115
  # @return [Array<String>]
28
116
  #
29
117
  # @!attribute [rw] vm_manager_name
30
- # VM Manager Name
118
+ # The name of the VM manager.
31
119
  # @return [String]
32
120
  #
33
121
  # @!attribute [rw] vm_manager_type
34
- # VM Management Product
122
+ # The VM management product.
35
123
  # @return [String]
36
124
  #
37
125
  # @!attribute [rw] vm_manager_id
38
- # Unique Identifier for VM Manager
126
+ # The identifier of the VM manager.
39
127
  # @return [String]
40
128
  #
41
129
  # @!attribute [rw] ip_address
42
- # Internet Protocol (IP) Address
130
+ # The IP address of the connector.
43
131
  # @return [String]
44
132
  #
45
133
  # @!attribute [rw] mac_address
46
- # Hardware (MAC) address
134
+ # The MAC address of the connector.
47
135
  # @return [String]
48
136
  #
49
137
  # @!attribute [rw] associated_on
50
- # Timestamp of an operation
138
+ # The time the connector was associated.
51
139
  # @return [Time]
52
140
  #
53
141
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/Connector AWS API Documentation
@@ -66,43 +154,172 @@ module Aws::SMS
66
154
  include Aws::Structure
67
155
  end
68
156
 
157
+ # @note When making an API call, you may pass CreateAppRequest
158
+ # data as a hash:
159
+ #
160
+ # {
161
+ # name: "AppName",
162
+ # description: "AppDescription",
163
+ # role_name: "RoleName",
164
+ # client_token: "ClientToken",
165
+ # server_groups: [
166
+ # {
167
+ # server_group_id: "ServerGroupId",
168
+ # name: "ServerGroupName",
169
+ # server_list: [
170
+ # {
171
+ # server_id: "ServerId",
172
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
173
+ # vm_server: {
174
+ # vm_server_address: {
175
+ # vm_manager_id: "VmManagerId",
176
+ # vm_id: "VmId",
177
+ # },
178
+ # vm_name: "VmName",
179
+ # vm_manager_name: "VmManagerName",
180
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
181
+ # vm_path: "VmPath",
182
+ # },
183
+ # replication_job_id: "ReplicationJobId",
184
+ # replication_job_terminated: false,
185
+ # },
186
+ # ],
187
+ # },
188
+ # ],
189
+ # tags: [
190
+ # {
191
+ # key: "TagKey",
192
+ # value: "TagValue",
193
+ # },
194
+ # ],
195
+ # }
196
+ #
197
+ # @!attribute [rw] name
198
+ # Name of the new application.
199
+ # @return [String]
200
+ #
201
+ # @!attribute [rw] description
202
+ # Description of the new application
203
+ # @return [String]
204
+ #
205
+ # @!attribute [rw] role_name
206
+ # Name of service role in customer's account to be used by AWS SMS.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] client_token
210
+ # A unique, case-sensitive identifier you provide to ensure
211
+ # idempotency of application creation.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] server_groups
215
+ # List of server groups to include in the application.
216
+ # @return [Array<Types::ServerGroup>]
217
+ #
218
+ # @!attribute [rw] tags
219
+ # List of tags to be associated with the application.
220
+ # @return [Array<Types::Tag>]
221
+ #
222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateAppRequest AWS API Documentation
223
+ #
224
+ class CreateAppRequest < Struct.new(
225
+ :name,
226
+ :description,
227
+ :role_name,
228
+ :client_token,
229
+ :server_groups,
230
+ :tags)
231
+ include Aws::Structure
232
+ end
233
+
234
+ # @!attribute [rw] app_summary
235
+ # Summary description of the application.
236
+ # @return [Types::AppSummary]
237
+ #
238
+ # @!attribute [rw] server_groups
239
+ # List of server groups included in the application.
240
+ # @return [Array<Types::ServerGroup>]
241
+ #
242
+ # @!attribute [rw] tags
243
+ # List of taags associated with the application.
244
+ # @return [Array<Types::Tag>]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateAppResponse AWS API Documentation
247
+ #
248
+ class CreateAppResponse < Struct.new(
249
+ :app_summary,
250
+ :server_groups,
251
+ :tags)
252
+ include Aws::Structure
253
+ end
254
+
69
255
  # @note When making an API call, you may pass CreateReplicationJobRequest
70
256
  # data as a hash:
71
257
  #
72
258
  # {
73
259
  # server_id: "ServerId", # required
74
260
  # seed_replication_time: Time.now, # required
75
- # frequency: 1, # required
261
+ # frequency: 1,
262
+ # run_once: false,
76
263
  # license_type: "AWS", # accepts AWS, BYOL
77
264
  # role_name: "RoleName",
78
265
  # description: "Description",
266
+ # number_of_recent_amis_to_keep: 1,
267
+ # encrypted: false,
268
+ # kms_key_id: "KmsKeyId",
79
269
  # }
80
270
  #
81
271
  # @!attribute [rw] server_id
82
- # Unique Identifier for a server
272
+ # The identifier of the server.
83
273
  # @return [String]
84
274
  #
85
275
  # @!attribute [rw] seed_replication_time
86
- # Timestamp of an operation
276
+ # The seed replication time.
87
277
  # @return [Time]
88
278
  #
89
279
  # @!attribute [rw] frequency
90
- # Interval between Replication Runs. This value is specified in hours,
91
- # and represents the time between consecutive Replication Runs.
280
+ # The time between consecutive replication runs, in hours.
92
281
  # @return [Integer]
93
282
  #
283
+ # @!attribute [rw] run_once
284
+ # @return [Boolean]
285
+ #
94
286
  # @!attribute [rw] license_type
95
- # The license type to be used for the Amazon Machine Image (AMI)
96
- # created after a successful ReplicationRun.
287
+ # The license type to be used for the AMI created by a successful
288
+ # replication run.
97
289
  # @return [String]
98
290
  #
99
291
  # @!attribute [rw] role_name
100
- # Name of service role in customer's account to be used by SMS
101
- # service.
292
+ # The name of the IAM role to be used by the AWS SMS.
102
293
  # @return [String]
103
294
  #
104
295
  # @!attribute [rw] description
105
- # The description for a Replication Job/Run.
296
+ # The description of the replication job.
297
+ # @return [String]
298
+ #
299
+ # @!attribute [rw] number_of_recent_amis_to_keep
300
+ # The maximum number of SMS-created AMIs to retain. The oldest will be
301
+ # deleted once the maximum number is reached and a new AMI is created.
302
+ # @return [Integer]
303
+ #
304
+ # @!attribute [rw] encrypted
305
+ # When *true*, the replication job produces encrypted AMIs. See also
306
+ # `KmsKeyId` below.
307
+ # @return [Boolean]
308
+ #
309
+ # @!attribute [rw] kms_key_id
310
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
311
+ # any of the following:
312
+ #
313
+ # * KMS key ID
314
+ #
315
+ # * KMS key alias
316
+ #
317
+ # * ARN referring to KMS key ID
318
+ #
319
+ # * ARN referring to KMS key alias
320
+ #
321
+ # If encrypted is *true* but a KMS key id is not specified, the
322
+ # customer's default KMS key for EBS is used.
106
323
  # @return [String]
107
324
  #
108
325
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJobRequest AWS API Documentation
@@ -111,14 +328,18 @@ module Aws::SMS
111
328
  :server_id,
112
329
  :seed_replication_time,
113
330
  :frequency,
331
+ :run_once,
114
332
  :license_type,
115
333
  :role_name,
116
- :description)
334
+ :description,
335
+ :number_of_recent_amis_to_keep,
336
+ :encrypted,
337
+ :kms_key_id)
117
338
  include Aws::Structure
118
339
  end
119
340
 
120
341
  # @!attribute [rw] replication_job_id
121
- # The unique identifier for a Replication Job.
342
+ # The unique identifier of the replication job.
122
343
  # @return [String]
123
344
  #
124
345
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJobResponse AWS API Documentation
@@ -128,6 +349,86 @@ module Aws::SMS
128
349
  include Aws::Structure
129
350
  end
130
351
 
352
+ # @note When making an API call, you may pass DeleteAppLaunchConfigurationRequest
353
+ # data as a hash:
354
+ #
355
+ # {
356
+ # app_id: "AppId",
357
+ # }
358
+ #
359
+ # @!attribute [rw] app_id
360
+ # ID of the application associated with the launch configuration.
361
+ # @return [String]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppLaunchConfigurationRequest AWS API Documentation
364
+ #
365
+ class DeleteAppLaunchConfigurationRequest < Struct.new(
366
+ :app_id)
367
+ include Aws::Structure
368
+ end
369
+
370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppLaunchConfigurationResponse AWS API Documentation
371
+ #
372
+ class DeleteAppLaunchConfigurationResponse < Aws::EmptyStructure; end
373
+
374
+ # @note When making an API call, you may pass DeleteAppReplicationConfigurationRequest
375
+ # data as a hash:
376
+ #
377
+ # {
378
+ # app_id: "AppId",
379
+ # }
380
+ #
381
+ # @!attribute [rw] app_id
382
+ # ID of the application associated with the replication configuration.
383
+ # @return [String]
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppReplicationConfigurationRequest AWS API Documentation
386
+ #
387
+ class DeleteAppReplicationConfigurationRequest < Struct.new(
388
+ :app_id)
389
+ include Aws::Structure
390
+ end
391
+
392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppReplicationConfigurationResponse AWS API Documentation
393
+ #
394
+ class DeleteAppReplicationConfigurationResponse < Aws::EmptyStructure; end
395
+
396
+ # @note When making an API call, you may pass DeleteAppRequest
397
+ # data as a hash:
398
+ #
399
+ # {
400
+ # app_id: "AppId",
401
+ # force_stop_app_replication: false,
402
+ # force_terminate_app: false,
403
+ # }
404
+ #
405
+ # @!attribute [rw] app_id
406
+ # ID of the application to delete.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] force_stop_app_replication
410
+ # While deleting the application, stop all replication jobs
411
+ # corresponding to the servers in the application.
412
+ # @return [Boolean]
413
+ #
414
+ # @!attribute [rw] force_terminate_app
415
+ # While deleting the application, terminate the stack corresponding to
416
+ # the application.
417
+ # @return [Boolean]
418
+ #
419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppRequest AWS API Documentation
420
+ #
421
+ class DeleteAppRequest < Struct.new(
422
+ :app_id,
423
+ :force_stop_app_replication,
424
+ :force_terminate_app)
425
+ include Aws::Structure
426
+ end
427
+
428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppResponse AWS API Documentation
429
+ #
430
+ class DeleteAppResponse < Aws::EmptyStructure; end
431
+
131
432
  # @note When making an API call, you may pass DeleteReplicationJobRequest
132
433
  # data as a hash:
133
434
  #
@@ -136,7 +437,7 @@ module Aws::SMS
136
437
  # }
137
438
  #
138
439
  # @!attribute [rw] replication_job_id
139
- # The unique identifier for a Replication Job.
440
+ # The identifier of the replication job.
140
441
  # @return [String]
141
442
  #
142
443
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteReplicationJobRequest AWS API Documentation
@@ -168,7 +469,7 @@ module Aws::SMS
168
469
  # }
169
470
  #
170
471
  # @!attribute [rw] connector_id
171
- # Unique Identifier for Connector
472
+ # The identifier of the connector.
172
473
  # @return [String]
173
474
  #
174
475
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DisassociateConnectorRequest AWS API Documentation
@@ -182,6 +483,186 @@ module Aws::SMS
182
483
  #
183
484
  class DisassociateConnectorResponse < Aws::EmptyStructure; end
184
485
 
486
+ # @note When making an API call, you may pass GenerateChangeSetRequest
487
+ # data as a hash:
488
+ #
489
+ # {
490
+ # app_id: "AppId",
491
+ # changeset_format: "JSON", # accepts JSON, YAML
492
+ # }
493
+ #
494
+ # @!attribute [rw] app_id
495
+ # ID of the application associated with the change set.
496
+ # @return [String]
497
+ #
498
+ # @!attribute [rw] changeset_format
499
+ # Format for the change set.
500
+ # @return [String]
501
+ #
502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateChangeSetRequest AWS API Documentation
503
+ #
504
+ class GenerateChangeSetRequest < Struct.new(
505
+ :app_id,
506
+ :changeset_format)
507
+ include Aws::Structure
508
+ end
509
+
510
+ # @!attribute [rw] s3_location
511
+ # Location of the Amazon S3 object.
512
+ # @return [Types::S3Location]
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateChangeSetResponse AWS API Documentation
515
+ #
516
+ class GenerateChangeSetResponse < Struct.new(
517
+ :s3_location)
518
+ include Aws::Structure
519
+ end
520
+
521
+ # @note When making an API call, you may pass GenerateTemplateRequest
522
+ # data as a hash:
523
+ #
524
+ # {
525
+ # app_id: "AppId",
526
+ # template_format: "JSON", # accepts JSON, YAML
527
+ # }
528
+ #
529
+ # @!attribute [rw] app_id
530
+ # ID of the application associated with the Amazon CloudFormation
531
+ # template.
532
+ # @return [String]
533
+ #
534
+ # @!attribute [rw] template_format
535
+ # Format for generating the Amazon CloudFormation template.
536
+ # @return [String]
537
+ #
538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateTemplateRequest AWS API Documentation
539
+ #
540
+ class GenerateTemplateRequest < Struct.new(
541
+ :app_id,
542
+ :template_format)
543
+ include Aws::Structure
544
+ end
545
+
546
+ # @!attribute [rw] s3_location
547
+ # Location of the Amazon S3 object.
548
+ # @return [Types::S3Location]
549
+ #
550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateTemplateResponse AWS API Documentation
551
+ #
552
+ class GenerateTemplateResponse < Struct.new(
553
+ :s3_location)
554
+ include Aws::Structure
555
+ end
556
+
557
+ # @note When making an API call, you may pass GetAppLaunchConfigurationRequest
558
+ # data as a hash:
559
+ #
560
+ # {
561
+ # app_id: "AppId",
562
+ # }
563
+ #
564
+ # @!attribute [rw] app_id
565
+ # ID of the application launch configuration.
566
+ # @return [String]
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppLaunchConfigurationRequest AWS API Documentation
569
+ #
570
+ class GetAppLaunchConfigurationRequest < Struct.new(
571
+ :app_id)
572
+ include Aws::Structure
573
+ end
574
+
575
+ # @!attribute [rw] app_id
576
+ # ID of the application associated with the launch configuration.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] role_name
580
+ # Name of the service role in the customer's account that Amazon
581
+ # CloudFormation uses to launch the application.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] server_group_launch_configurations
585
+ # List of launch configurations for server groups in this application.
586
+ # @return [Array<Types::ServerGroupLaunchConfiguration>]
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppLaunchConfigurationResponse AWS API Documentation
589
+ #
590
+ class GetAppLaunchConfigurationResponse < Struct.new(
591
+ :app_id,
592
+ :role_name,
593
+ :server_group_launch_configurations)
594
+ include Aws::Structure
595
+ end
596
+
597
+ # @note When making an API call, you may pass GetAppReplicationConfigurationRequest
598
+ # data as a hash:
599
+ #
600
+ # {
601
+ # app_id: "AppId",
602
+ # }
603
+ #
604
+ # @!attribute [rw] app_id
605
+ # ID of the application associated with the replication configuration.
606
+ # @return [String]
607
+ #
608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppReplicationConfigurationRequest AWS API Documentation
609
+ #
610
+ class GetAppReplicationConfigurationRequest < Struct.new(
611
+ :app_id)
612
+ include Aws::Structure
613
+ end
614
+
615
+ # @!attribute [rw] server_group_replication_configurations
616
+ # Replication configurations associated with server groups in this
617
+ # application.
618
+ # @return [Array<Types::ServerGroupReplicationConfiguration>]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppReplicationConfigurationResponse AWS API Documentation
621
+ #
622
+ class GetAppReplicationConfigurationResponse < Struct.new(
623
+ :server_group_replication_configurations)
624
+ include Aws::Structure
625
+ end
626
+
627
+ # @note When making an API call, you may pass GetAppRequest
628
+ # data as a hash:
629
+ #
630
+ # {
631
+ # app_id: "AppId",
632
+ # }
633
+ #
634
+ # @!attribute [rw] app_id
635
+ # ID of the application whose information is being retrieved.
636
+ # @return [String]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppRequest AWS API Documentation
639
+ #
640
+ class GetAppRequest < Struct.new(
641
+ :app_id)
642
+ include Aws::Structure
643
+ end
644
+
645
+ # @!attribute [rw] app_summary
646
+ # Information about the application.
647
+ # @return [Types::AppSummary]
648
+ #
649
+ # @!attribute [rw] server_groups
650
+ # List of server groups belonging to the application.
651
+ # @return [Array<Types::ServerGroup>]
652
+ #
653
+ # @!attribute [rw] tags
654
+ # List of tags associated with the application.
655
+ # @return [Array<Types::Tag>]
656
+ #
657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppResponse AWS API Documentation
658
+ #
659
+ class GetAppResponse < Struct.new(
660
+ :app_summary,
661
+ :server_groups,
662
+ :tags)
663
+ include Aws::Structure
664
+ end
665
+
185
666
  # @note When making an API call, you may pass GetConnectorsRequest
186
667
  # data as a hash:
187
668
  #
@@ -191,12 +672,13 @@ module Aws::SMS
191
672
  # }
192
673
  #
193
674
  # @!attribute [rw] next_token
194
- # Pagination token to pass as input to API call
675
+ # The token for the next set of results.
195
676
  # @return [String]
196
677
  #
197
678
  # @!attribute [rw] max_results
198
- # The maximum number of results to return in one API call. If left
199
- # empty, this will default to 50.
679
+ # The maximum number of results to return in a single call. The
680
+ # default value is 50. To retrieve the remaining results, make another
681
+ # call with the returned `NextToken` value.
200
682
  # @return [Integer]
201
683
  #
202
684
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectorsRequest AWS API Documentation
@@ -208,11 +690,12 @@ module Aws::SMS
208
690
  end
209
691
 
210
692
  # @!attribute [rw] connector_list
211
- # List of connectors
693
+ # Information about the registered connectors.
212
694
  # @return [Array<Types::Connector>]
213
695
  #
214
696
  # @!attribute [rw] next_token
215
- # Pagination token to pass as input to API call
697
+ # The token required to retrieve the next set of results. This value
698
+ # is null when there are no more results to return.
216
699
  # @return [String]
217
700
  #
218
701
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectorsResponse AWS API Documentation
@@ -233,16 +716,17 @@ module Aws::SMS
233
716
  # }
234
717
  #
235
718
  # @!attribute [rw] replication_job_id
236
- # The unique identifier for a Replication Job.
719
+ # The identifier of the replication job.
237
720
  # @return [String]
238
721
  #
239
722
  # @!attribute [rw] next_token
240
- # Pagination token to pass as input to API call
723
+ # The token for the next set of results.
241
724
  # @return [String]
242
725
  #
243
726
  # @!attribute [rw] max_results
244
- # The maximum number of results to return in one API call. If left
245
- # empty, this will default to 50.
727
+ # The maximum number of results to return in a single call. The
728
+ # default value is 50. To retrieve the remaining results, make another
729
+ # call with the returned `NextToken` value.
246
730
  # @return [Integer]
247
731
  #
248
732
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobsRequest AWS API Documentation
@@ -255,11 +739,12 @@ module Aws::SMS
255
739
  end
256
740
 
257
741
  # @!attribute [rw] replication_job_list
258
- # List of Replication Jobs
742
+ # Information about the replication jobs.
259
743
  # @return [Array<Types::ReplicationJob>]
260
744
  #
261
745
  # @!attribute [rw] next_token
262
- # Pagination token to pass as input to API call
746
+ # The token required to retrieve the next set of results. This value
747
+ # is null when there are no more results to return.
263
748
  # @return [String]
264
749
  #
265
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobsResponse AWS API Documentation
@@ -280,16 +765,17 @@ module Aws::SMS
280
765
  # }
281
766
  #
282
767
  # @!attribute [rw] replication_job_id
283
- # The unique identifier for a Replication Job.
768
+ # The identifier of the replication job.
284
769
  # @return [String]
285
770
  #
286
771
  # @!attribute [rw] next_token
287
- # Pagination token to pass as input to API call
772
+ # The token for the next set of results.
288
773
  # @return [String]
289
774
  #
290
775
  # @!attribute [rw] max_results
291
- # The maximum number of results to return in one API call. If left
292
- # empty, this will default to 50.
776
+ # The maximum number of results to return in a single call. The
777
+ # default value is 50. To retrieve the remaining results, make another
778
+ # call with the returned `NextToken` value.
293
779
  # @return [Integer]
294
780
  #
295
781
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRunsRequest AWS API Documentation
@@ -302,15 +788,16 @@ module Aws::SMS
302
788
  end
303
789
 
304
790
  # @!attribute [rw] replication_job
305
- # Object representing a Replication Job
791
+ # Information about the replication job.
306
792
  # @return [Types::ReplicationJob]
307
793
  #
308
794
  # @!attribute [rw] replication_run_list
309
- # List of Replication Runs
795
+ # Information about the replication runs.
310
796
  # @return [Array<Types::ReplicationRun>]
311
797
  #
312
798
  # @!attribute [rw] next_token
313
- # Pagination token to pass as input to API call
799
+ # The token required to retrieve the next set of results. This value
800
+ # is null when there are no more results to return.
314
801
  # @return [String]
315
802
  #
316
803
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRunsResponse AWS API Documentation
@@ -328,39 +815,52 @@ module Aws::SMS
328
815
  # {
329
816
  # next_token: "NextToken",
330
817
  # max_results: 1,
818
+ # vm_server_address_list: [
819
+ # {
820
+ # vm_manager_id: "VmManagerId",
821
+ # vm_id: "VmId",
822
+ # },
823
+ # ],
331
824
  # }
332
825
  #
333
826
  # @!attribute [rw] next_token
334
- # Pagination token to pass as input to API call
827
+ # The token for the next set of results.
335
828
  # @return [String]
336
829
  #
337
830
  # @!attribute [rw] max_results
338
- # The maximum number of results to return in one API call. If left
339
- # empty, this will default to 50.
831
+ # The maximum number of results to return in a single call. The
832
+ # default value is 50. To retrieve the remaining results, make another
833
+ # call with the returned `NextToken` value.
340
834
  # @return [Integer]
341
835
  #
836
+ # @!attribute [rw] vm_server_address_list
837
+ # List of `VmServerAddress` objects
838
+ # @return [Array<Types::VmServerAddress>]
839
+ #
342
840
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServersRequest AWS API Documentation
343
841
  #
344
842
  class GetServersRequest < Struct.new(
345
843
  :next_token,
346
- :max_results)
844
+ :max_results,
845
+ :vm_server_address_list)
347
846
  include Aws::Structure
348
847
  end
349
848
 
350
849
  # @!attribute [rw] last_modified_on
351
- # Timestamp of an operation
850
+ # The time when the server was last modified.
352
851
  # @return [Time]
353
852
  #
354
853
  # @!attribute [rw] server_catalog_status
355
- # Status of Server catalog
854
+ # The status of the server catalog.
356
855
  # @return [String]
357
856
  #
358
857
  # @!attribute [rw] server_list
359
- # List of servers from catalog
858
+ # Information about the servers.
360
859
  # @return [Array<Types::Server>]
361
860
  #
362
861
  # @!attribute [rw] next_token
363
- # Pagination token to pass as input to API call
862
+ # The token required to retrieve the next set of results. This value
863
+ # is null when there are no more results to return.
364
864
  # @return [String]
365
865
  #
366
866
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServersResponse AWS API Documentation
@@ -383,65 +883,321 @@ module Aws::SMS
383
883
  #
384
884
  class ImportServerCatalogResponse < Aws::EmptyStructure; end
385
885
 
386
- # Object representing a Replication Job
387
- #
388
- # @!attribute [rw] replication_job_id
389
- # The unique identifier for a Replication Job.
390
- # @return [String]
886
+ # @note When making an API call, you may pass LaunchAppRequest
887
+ # data as a hash:
391
888
  #
392
- # @!attribute [rw] server_id
393
- # Unique Identifier for a server
394
- # @return [String]
889
+ # {
890
+ # app_id: "AppId",
891
+ # }
395
892
  #
396
- # @!attribute [rw] server_type
397
- # Type of server.
893
+ # @!attribute [rw] app_id
894
+ # ID of the application to launch.
398
895
  # @return [String]
399
896
  #
400
- # @!attribute [rw] vm_server
401
- # Object representing a VM server
402
- # @return [Types::VmServer]
897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/LaunchAppRequest AWS API Documentation
403
898
  #
404
- # @!attribute [rw] seed_replication_time
405
- # Timestamp of an operation
406
- # @return [Time]
899
+ class LaunchAppRequest < Struct.new(
900
+ :app_id)
901
+ include Aws::Structure
902
+ end
903
+
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/LaunchAppResponse AWS API Documentation
407
905
  #
408
- # @!attribute [rw] frequency
409
- # Interval between Replication Runs. This value is specified in hours,
410
- # and represents the time between consecutive Replication Runs.
411
- # @return [Integer]
906
+ class LaunchAppResponse < Aws::EmptyStructure; end
907
+
908
+ # Details about the latest launch of an application.
412
909
  #
413
- # @!attribute [rw] next_replication_run_start_time
414
- # Timestamp of an operation
910
+ # @!attribute [rw] latest_launch_time
911
+ # Latest time this application was launched successfully.
415
912
  # @return [Time]
416
913
  #
417
- # @!attribute [rw] license_type
418
- # The license type to be used for the Amazon Machine Image (AMI)
419
- # created after a successful ReplicationRun.
420
- # @return [String]
421
- #
422
- # @!attribute [rw] role_name
423
- # Name of service role in customer's account to be used by SMS
424
- # service.
914
+ # @!attribute [rw] stack_name
915
+ # Name of the latest stack launched for this application.
425
916
  # @return [String]
426
917
  #
427
- # @!attribute [rw] latest_ami_id
428
- # The AMI id for the image resulting from a Replication Run.
918
+ # @!attribute [rw] stack_id
919
+ # Identifier of the latest stack launched for this application.
429
920
  # @return [String]
430
921
  #
431
- # @!attribute [rw] state
432
- # Current state of Replication Job
433
- # @return [String]
922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/LaunchDetails AWS API Documentation
434
923
  #
435
- # @!attribute [rw] status_message
436
- # String describing current status of Replication Job
924
+ class LaunchDetails < Struct.new(
925
+ :latest_launch_time,
926
+ :stack_name,
927
+ :stack_id)
928
+ include Aws::Structure
929
+ end
930
+
931
+ # @note When making an API call, you may pass ListAppsRequest
932
+ # data as a hash:
933
+ #
934
+ # {
935
+ # app_ids: ["AppId"],
936
+ # next_token: "NextToken",
937
+ # max_results: 1,
938
+ # }
939
+ #
940
+ # @!attribute [rw] app_ids
941
+ # @return [Array<String>]
942
+ #
943
+ # @!attribute [rw] next_token
944
+ # The token for the next set of results.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] max_results
948
+ # The maximum number of results to return in a single call. The
949
+ # default value is 50. To retrieve the remaining results, make another
950
+ # call with the returned `NextToken` value.
951
+ # @return [Integer]
952
+ #
953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ListAppsRequest AWS API Documentation
954
+ #
955
+ class ListAppsRequest < Struct.new(
956
+ :app_ids,
957
+ :next_token,
958
+ :max_results)
959
+ include Aws::Structure
960
+ end
961
+
962
+ # @!attribute [rw] apps
963
+ # A list of application summaries.
964
+ # @return [Array<Types::AppSummary>]
965
+ #
966
+ # @!attribute [rw] next_token
967
+ # The token required to retrieve the next set of results. This value
968
+ # is null when there are no more results to return.
969
+ # @return [String]
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ListAppsResponse AWS API Documentation
972
+ #
973
+ class ListAppsResponse < Struct.new(
974
+ :apps,
975
+ :next_token)
976
+ include Aws::Structure
977
+ end
978
+
979
+ # @note When making an API call, you may pass PutAppLaunchConfigurationRequest
980
+ # data as a hash:
981
+ #
982
+ # {
983
+ # app_id: "AppId",
984
+ # role_name: "RoleName",
985
+ # server_group_launch_configurations: [
986
+ # {
987
+ # server_group_id: "ServerGroupId",
988
+ # launch_order: 1,
989
+ # server_launch_configurations: [
990
+ # {
991
+ # server: {
992
+ # server_id: "ServerId",
993
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
994
+ # vm_server: {
995
+ # vm_server_address: {
996
+ # vm_manager_id: "VmManagerId",
997
+ # vm_id: "VmId",
998
+ # },
999
+ # vm_name: "VmName",
1000
+ # vm_manager_name: "VmManagerName",
1001
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1002
+ # vm_path: "VmPath",
1003
+ # },
1004
+ # replication_job_id: "ReplicationJobId",
1005
+ # replication_job_terminated: false,
1006
+ # },
1007
+ # logical_id: "LogicalId",
1008
+ # vpc: "VPC",
1009
+ # subnet: "Subnet",
1010
+ # security_group: "SecurityGroup",
1011
+ # ec2_key_name: "EC2KeyName",
1012
+ # user_data: {
1013
+ # s3_location: {
1014
+ # bucket: "BucketName",
1015
+ # key: "KeyName",
1016
+ # },
1017
+ # },
1018
+ # instance_type: "InstanceType",
1019
+ # associate_public_ip_address: false,
1020
+ # },
1021
+ # ],
1022
+ # },
1023
+ # ],
1024
+ # }
1025
+ #
1026
+ # @!attribute [rw] app_id
1027
+ # ID of the application associated with the launch configuration.
1028
+ # @return [String]
1029
+ #
1030
+ # @!attribute [rw] role_name
1031
+ # Name of service role in the customer's account that Amazon
1032
+ # CloudFormation uses to launch the application.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] server_group_launch_configurations
1036
+ # Launch configurations for server groups in the application.
1037
+ # @return [Array<Types::ServerGroupLaunchConfiguration>]
1038
+ #
1039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppLaunchConfigurationRequest AWS API Documentation
1040
+ #
1041
+ class PutAppLaunchConfigurationRequest < Struct.new(
1042
+ :app_id,
1043
+ :role_name,
1044
+ :server_group_launch_configurations)
1045
+ include Aws::Structure
1046
+ end
1047
+
1048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppLaunchConfigurationResponse AWS API Documentation
1049
+ #
1050
+ class PutAppLaunchConfigurationResponse < Aws::EmptyStructure; end
1051
+
1052
+ # @note When making an API call, you may pass PutAppReplicationConfigurationRequest
1053
+ # data as a hash:
1054
+ #
1055
+ # {
1056
+ # app_id: "AppId",
1057
+ # server_group_replication_configurations: [
1058
+ # {
1059
+ # server_group_id: "ServerGroupId",
1060
+ # server_replication_configurations: [
1061
+ # {
1062
+ # server: {
1063
+ # server_id: "ServerId",
1064
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1065
+ # vm_server: {
1066
+ # vm_server_address: {
1067
+ # vm_manager_id: "VmManagerId",
1068
+ # vm_id: "VmId",
1069
+ # },
1070
+ # vm_name: "VmName",
1071
+ # vm_manager_name: "VmManagerName",
1072
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1073
+ # vm_path: "VmPath",
1074
+ # },
1075
+ # replication_job_id: "ReplicationJobId",
1076
+ # replication_job_terminated: false,
1077
+ # },
1078
+ # server_replication_parameters: {
1079
+ # seed_time: Time.now,
1080
+ # frequency: 1,
1081
+ # run_once: false,
1082
+ # license_type: "AWS", # accepts AWS, BYOL
1083
+ # number_of_recent_amis_to_keep: 1,
1084
+ # encrypted: false,
1085
+ # kms_key_id: "KmsKeyId",
1086
+ # },
1087
+ # },
1088
+ # ],
1089
+ # },
1090
+ # ],
1091
+ # }
1092
+ #
1093
+ # @!attribute [rw] app_id
1094
+ # ID of the application tassociated with the replication
1095
+ # configuration.
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] server_group_replication_configurations
1099
+ # Replication configurations for server groups in the application.
1100
+ # @return [Array<Types::ServerGroupReplicationConfiguration>]
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppReplicationConfigurationRequest AWS API Documentation
1103
+ #
1104
+ class PutAppReplicationConfigurationRequest < Struct.new(
1105
+ :app_id,
1106
+ :server_group_replication_configurations)
1107
+ include Aws::Structure
1108
+ end
1109
+
1110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppReplicationConfigurationResponse AWS API Documentation
1111
+ #
1112
+ class PutAppReplicationConfigurationResponse < Aws::EmptyStructure; end
1113
+
1114
+ # Represents a replication job.
1115
+ #
1116
+ # @!attribute [rw] replication_job_id
1117
+ # The identifier of the replication job.
1118
+ # @return [String]
1119
+ #
1120
+ # @!attribute [rw] server_id
1121
+ # The identifier of the server.
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] server_type
1125
+ # The type of server.
1126
+ # @return [String]
1127
+ #
1128
+ # @!attribute [rw] vm_server
1129
+ # Information about the VM server.
1130
+ # @return [Types::VmServer]
1131
+ #
1132
+ # @!attribute [rw] seed_replication_time
1133
+ # The seed replication time.
1134
+ # @return [Time]
1135
+ #
1136
+ # @!attribute [rw] frequency
1137
+ # The time between consecutive replication runs, in hours.
1138
+ # @return [Integer]
1139
+ #
1140
+ # @!attribute [rw] run_once
1141
+ # @return [Boolean]
1142
+ #
1143
+ # @!attribute [rw] next_replication_run_start_time
1144
+ # The start time of the next replication run.
1145
+ # @return [Time]
1146
+ #
1147
+ # @!attribute [rw] license_type
1148
+ # The license type to be used for the AMI created by a successful
1149
+ # replication run.
1150
+ # @return [String]
1151
+ #
1152
+ # @!attribute [rw] role_name
1153
+ # The name of the IAM role to be used by the Server Migration Service.
1154
+ # @return [String]
1155
+ #
1156
+ # @!attribute [rw] latest_ami_id
1157
+ # The ID of the latest Amazon Machine Image (AMI).
1158
+ # @return [String]
1159
+ #
1160
+ # @!attribute [rw] state
1161
+ # The state of the replication job.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] status_message
1165
+ # The description of the current status of the replication job.
437
1166
  # @return [String]
438
1167
  #
439
1168
  # @!attribute [rw] description
440
- # The description for a Replication Job/Run.
1169
+ # The description of the replication job.
1170
+ # @return [String]
1171
+ #
1172
+ # @!attribute [rw] number_of_recent_amis_to_keep
1173
+ # Number of recent AMIs to keep in the customer's account for a
1174
+ # replication job. By default the value is set to zero, meaning that
1175
+ # all AMIs are kept.
1176
+ # @return [Integer]
1177
+ #
1178
+ # @!attribute [rw] encrypted
1179
+ # Whether the replication job should produce encrypted AMIs or not.
1180
+ # See also `KmsKeyId` below.
1181
+ # @return [Boolean]
1182
+ #
1183
+ # @!attribute [rw] kms_key_id
1184
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
1185
+ # any of the following:
1186
+ #
1187
+ # * KMS key ID
1188
+ #
1189
+ # * KMS key alias
1190
+ #
1191
+ # * ARN referring to KMS key ID
1192
+ #
1193
+ # * ARN referring to KMS key alias
1194
+ #
1195
+ # If encrypted is *true* but a KMS key id is not specified, the
1196
+ # customer's default KMS key for EBS is used.
441
1197
  # @return [String]
442
1198
  #
443
1199
  # @!attribute [rw] replication_run_list
444
- # List of Replication Runs
1200
+ # Information about the replication runs.
445
1201
  # @return [Array<Types::ReplicationRun>]
446
1202
  #
447
1203
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ReplicationJob AWS API Documentation
@@ -453,6 +1209,7 @@ module Aws::SMS
453
1209
  :vm_server,
454
1210
  :seed_replication_time,
455
1211
  :frequency,
1212
+ :run_once,
456
1213
  :next_replication_run_start_time,
457
1214
  :license_type,
458
1215
  :role_name,
@@ -460,42 +1217,71 @@ module Aws::SMS
460
1217
  :state,
461
1218
  :status_message,
462
1219
  :description,
1220
+ :number_of_recent_amis_to_keep,
1221
+ :encrypted,
1222
+ :kms_key_id,
463
1223
  :replication_run_list)
464
1224
  include Aws::Structure
465
1225
  end
466
1226
 
467
- # Object representing a Replication Run
1227
+ # Represents a replication run.
468
1228
  #
469
1229
  # @!attribute [rw] replication_run_id
470
- # The unique identifier for a Replication Run.
1230
+ # The identifier of the replication run.
471
1231
  # @return [String]
472
1232
  #
473
1233
  # @!attribute [rw] state
474
- # Current state of Replication Run
1234
+ # The state of the replication run.
475
1235
  # @return [String]
476
1236
  #
477
1237
  # @!attribute [rw] type
478
- # Type of Replication Run
1238
+ # The type of replication run.
479
1239
  # @return [String]
480
1240
  #
1241
+ # @!attribute [rw] stage_details
1242
+ # Details of the current stage of the replication run.
1243
+ # @return [Types::ReplicationRunStageDetails]
1244
+ #
481
1245
  # @!attribute [rw] status_message
482
- # String describing current status of Replication Run
1246
+ # The description of the current status of the replication job.
483
1247
  # @return [String]
484
1248
  #
485
1249
  # @!attribute [rw] ami_id
486
- # The AMI id for the image resulting from a Replication Run.
1250
+ # The identifier of the Amazon Machine Image (AMI) from the
1251
+ # replication run.
487
1252
  # @return [String]
488
1253
  #
489
1254
  # @!attribute [rw] scheduled_start_time
490
- # Timestamp of an operation
1255
+ # The start time of the next replication run.
491
1256
  # @return [Time]
492
1257
  #
493
1258
  # @!attribute [rw] completed_time
494
- # Timestamp of an operation
1259
+ # The completion time of the last replication run.
495
1260
  # @return [Time]
496
1261
  #
497
1262
  # @!attribute [rw] description
498
- # The description for a Replication Job/Run.
1263
+ # The description of the replication run.
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] encrypted
1267
+ # Whether the replication run should produce encrypted AMI or not. See
1268
+ # also `KmsKeyId` below.
1269
+ # @return [Boolean]
1270
+ #
1271
+ # @!attribute [rw] kms_key_id
1272
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
1273
+ # any of the following:
1274
+ #
1275
+ # * KMS key ID
1276
+ #
1277
+ # * KMS key alias
1278
+ #
1279
+ # * ARN referring to KMS key ID
1280
+ #
1281
+ # * ARN referring to KMS key alias
1282
+ #
1283
+ # If encrypted is *true* but a KMS key id is not specified, the
1284
+ # customer's default KMS key for EBS is used.
499
1285
  # @return [String]
500
1286
  #
501
1287
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ReplicationRun AWS API Documentation
@@ -504,34 +1290,102 @@ module Aws::SMS
504
1290
  :replication_run_id,
505
1291
  :state,
506
1292
  :type,
1293
+ :stage_details,
507
1294
  :status_message,
508
1295
  :ami_id,
509
1296
  :scheduled_start_time,
510
1297
  :completed_time,
511
- :description)
1298
+ :description,
1299
+ :encrypted,
1300
+ :kms_key_id)
1301
+ include Aws::Structure
1302
+ end
1303
+
1304
+ # Details of the current stage of a replication run.
1305
+ #
1306
+ # @!attribute [rw] stage
1307
+ # String describing the current stage of a replication run.
1308
+ # @return [String]
1309
+ #
1310
+ # @!attribute [rw] stage_progress
1311
+ # String describing the progress of the current stage of a replication
1312
+ # run.
1313
+ # @return [String]
1314
+ #
1315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ReplicationRunStageDetails AWS API Documentation
1316
+ #
1317
+ class ReplicationRunStageDetails < Struct.new(
1318
+ :stage,
1319
+ :stage_progress)
512
1320
  include Aws::Structure
513
1321
  end
514
1322
 
515
- # Object representing a server
1323
+ # Location of the Amazon S3 object in the customer's account.
1324
+ #
1325
+ # @note When making an API call, you may pass S3Location
1326
+ # data as a hash:
1327
+ #
1328
+ # {
1329
+ # bucket: "BucketName",
1330
+ # key: "KeyName",
1331
+ # }
1332
+ #
1333
+ # @!attribute [rw] bucket
1334
+ # Amazon S3 bucket name.
1335
+ # @return [String]
1336
+ #
1337
+ # @!attribute [rw] key
1338
+ # Amazon S3 bucket key.
1339
+ # @return [String]
1340
+ #
1341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/S3Location AWS API Documentation
1342
+ #
1343
+ class S3Location < Struct.new(
1344
+ :bucket,
1345
+ :key)
1346
+ include Aws::Structure
1347
+ end
1348
+
1349
+ # Represents a server.
1350
+ #
1351
+ # @note When making an API call, you may pass Server
1352
+ # data as a hash:
1353
+ #
1354
+ # {
1355
+ # server_id: "ServerId",
1356
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1357
+ # vm_server: {
1358
+ # vm_server_address: {
1359
+ # vm_manager_id: "VmManagerId",
1360
+ # vm_id: "VmId",
1361
+ # },
1362
+ # vm_name: "VmName",
1363
+ # vm_manager_name: "VmManagerName",
1364
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1365
+ # vm_path: "VmPath",
1366
+ # },
1367
+ # replication_job_id: "ReplicationJobId",
1368
+ # replication_job_terminated: false,
1369
+ # }
516
1370
  #
517
1371
  # @!attribute [rw] server_id
518
- # Unique Identifier for a server
1372
+ # The identifier of the server.
519
1373
  # @return [String]
520
1374
  #
521
1375
  # @!attribute [rw] server_type
522
- # Type of server.
1376
+ # The type of server.
523
1377
  # @return [String]
524
1378
  #
525
1379
  # @!attribute [rw] vm_server
526
- # Object representing a VM server
1380
+ # Information about the VM server.
527
1381
  # @return [Types::VmServer]
528
1382
  #
529
1383
  # @!attribute [rw] replication_job_id
530
- # The unique identifier for a Replication Job.
1384
+ # The identifier of the replication job.
531
1385
  # @return [String]
532
1386
  #
533
1387
  # @!attribute [rw] replication_job_terminated
534
- # An indicator of the Replication Job being deleted or failed.
1388
+ # Indicates whether the replication job is deleted or failed.
535
1389
  # @return [Boolean]
536
1390
  #
537
1391
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/Server AWS API Documentation
@@ -545,6 +1399,409 @@ module Aws::SMS
545
1399
  include Aws::Structure
546
1400
  end
547
1401
 
1402
+ # A logical grouping of servers.
1403
+ #
1404
+ # @note When making an API call, you may pass ServerGroup
1405
+ # data as a hash:
1406
+ #
1407
+ # {
1408
+ # server_group_id: "ServerGroupId",
1409
+ # name: "ServerGroupName",
1410
+ # server_list: [
1411
+ # {
1412
+ # server_id: "ServerId",
1413
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1414
+ # vm_server: {
1415
+ # vm_server_address: {
1416
+ # vm_manager_id: "VmManagerId",
1417
+ # vm_id: "VmId",
1418
+ # },
1419
+ # vm_name: "VmName",
1420
+ # vm_manager_name: "VmManagerName",
1421
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1422
+ # vm_path: "VmPath",
1423
+ # },
1424
+ # replication_job_id: "ReplicationJobId",
1425
+ # replication_job_terminated: false,
1426
+ # },
1427
+ # ],
1428
+ # }
1429
+ #
1430
+ # @!attribute [rw] server_group_id
1431
+ # Identifier of a server group.
1432
+ # @return [String]
1433
+ #
1434
+ # @!attribute [rw] name
1435
+ # Name of a server group.
1436
+ # @return [String]
1437
+ #
1438
+ # @!attribute [rw] server_list
1439
+ # List of servers belonging to a server group.
1440
+ # @return [Array<Types::Server>]
1441
+ #
1442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerGroup AWS API Documentation
1443
+ #
1444
+ class ServerGroup < Struct.new(
1445
+ :server_group_id,
1446
+ :name,
1447
+ :server_list)
1448
+ include Aws::Structure
1449
+ end
1450
+
1451
+ # Launch configuration for a server group.
1452
+ #
1453
+ # @note When making an API call, you may pass ServerGroupLaunchConfiguration
1454
+ # data as a hash:
1455
+ #
1456
+ # {
1457
+ # server_group_id: "ServerGroupId",
1458
+ # launch_order: 1,
1459
+ # server_launch_configurations: [
1460
+ # {
1461
+ # server: {
1462
+ # server_id: "ServerId",
1463
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1464
+ # vm_server: {
1465
+ # vm_server_address: {
1466
+ # vm_manager_id: "VmManagerId",
1467
+ # vm_id: "VmId",
1468
+ # },
1469
+ # vm_name: "VmName",
1470
+ # vm_manager_name: "VmManagerName",
1471
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1472
+ # vm_path: "VmPath",
1473
+ # },
1474
+ # replication_job_id: "ReplicationJobId",
1475
+ # replication_job_terminated: false,
1476
+ # },
1477
+ # logical_id: "LogicalId",
1478
+ # vpc: "VPC",
1479
+ # subnet: "Subnet",
1480
+ # security_group: "SecurityGroup",
1481
+ # ec2_key_name: "EC2KeyName",
1482
+ # user_data: {
1483
+ # s3_location: {
1484
+ # bucket: "BucketName",
1485
+ # key: "KeyName",
1486
+ # },
1487
+ # },
1488
+ # instance_type: "InstanceType",
1489
+ # associate_public_ip_address: false,
1490
+ # },
1491
+ # ],
1492
+ # }
1493
+ #
1494
+ # @!attribute [rw] server_group_id
1495
+ # Identifier of the server group the launch configuration is
1496
+ # associated with.
1497
+ # @return [String]
1498
+ #
1499
+ # @!attribute [rw] launch_order
1500
+ # Launch order of servers in the server group.
1501
+ # @return [Integer]
1502
+ #
1503
+ # @!attribute [rw] server_launch_configurations
1504
+ # Launch configuration for servers in the server group.
1505
+ # @return [Array<Types::ServerLaunchConfiguration>]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerGroupLaunchConfiguration AWS API Documentation
1508
+ #
1509
+ class ServerGroupLaunchConfiguration < Struct.new(
1510
+ :server_group_id,
1511
+ :launch_order,
1512
+ :server_launch_configurations)
1513
+ include Aws::Structure
1514
+ end
1515
+
1516
+ # Replication configuration for a server group.
1517
+ #
1518
+ # @note When making an API call, you may pass ServerGroupReplicationConfiguration
1519
+ # data as a hash:
1520
+ #
1521
+ # {
1522
+ # server_group_id: "ServerGroupId",
1523
+ # server_replication_configurations: [
1524
+ # {
1525
+ # server: {
1526
+ # server_id: "ServerId",
1527
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1528
+ # vm_server: {
1529
+ # vm_server_address: {
1530
+ # vm_manager_id: "VmManagerId",
1531
+ # vm_id: "VmId",
1532
+ # },
1533
+ # vm_name: "VmName",
1534
+ # vm_manager_name: "VmManagerName",
1535
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1536
+ # vm_path: "VmPath",
1537
+ # },
1538
+ # replication_job_id: "ReplicationJobId",
1539
+ # replication_job_terminated: false,
1540
+ # },
1541
+ # server_replication_parameters: {
1542
+ # seed_time: Time.now,
1543
+ # frequency: 1,
1544
+ # run_once: false,
1545
+ # license_type: "AWS", # accepts AWS, BYOL
1546
+ # number_of_recent_amis_to_keep: 1,
1547
+ # encrypted: false,
1548
+ # kms_key_id: "KmsKeyId",
1549
+ # },
1550
+ # },
1551
+ # ],
1552
+ # }
1553
+ #
1554
+ # @!attribute [rw] server_group_id
1555
+ # Identifier of the server group this replication configuration is
1556
+ # associated with.
1557
+ # @return [String]
1558
+ #
1559
+ # @!attribute [rw] server_replication_configurations
1560
+ # Replication configuration for servers in the server group.
1561
+ # @return [Array<Types::ServerReplicationConfiguration>]
1562
+ #
1563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerGroupReplicationConfiguration AWS API Documentation
1564
+ #
1565
+ class ServerGroupReplicationConfiguration < Struct.new(
1566
+ :server_group_id,
1567
+ :server_replication_configurations)
1568
+ include Aws::Structure
1569
+ end
1570
+
1571
+ # Launch configuration for a server.
1572
+ #
1573
+ # @note When making an API call, you may pass ServerLaunchConfiguration
1574
+ # data as a hash:
1575
+ #
1576
+ # {
1577
+ # server: {
1578
+ # server_id: "ServerId",
1579
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1580
+ # vm_server: {
1581
+ # vm_server_address: {
1582
+ # vm_manager_id: "VmManagerId",
1583
+ # vm_id: "VmId",
1584
+ # },
1585
+ # vm_name: "VmName",
1586
+ # vm_manager_name: "VmManagerName",
1587
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1588
+ # vm_path: "VmPath",
1589
+ # },
1590
+ # replication_job_id: "ReplicationJobId",
1591
+ # replication_job_terminated: false,
1592
+ # },
1593
+ # logical_id: "LogicalId",
1594
+ # vpc: "VPC",
1595
+ # subnet: "Subnet",
1596
+ # security_group: "SecurityGroup",
1597
+ # ec2_key_name: "EC2KeyName",
1598
+ # user_data: {
1599
+ # s3_location: {
1600
+ # bucket: "BucketName",
1601
+ # key: "KeyName",
1602
+ # },
1603
+ # },
1604
+ # instance_type: "InstanceType",
1605
+ # associate_public_ip_address: false,
1606
+ # }
1607
+ #
1608
+ # @!attribute [rw] server
1609
+ # Identifier of the server the launch configuration is associated
1610
+ # with.
1611
+ # @return [Types::Server]
1612
+ #
1613
+ # @!attribute [rw] logical_id
1614
+ # Logical ID of the server in the Amazon CloudFormation template.
1615
+ # @return [String]
1616
+ #
1617
+ # @!attribute [rw] vpc
1618
+ # Identifier of the VPC the server should be launched into.
1619
+ # @return [String]
1620
+ #
1621
+ # @!attribute [rw] subnet
1622
+ # Identifier of the subnet the server should be launched into.
1623
+ # @return [String]
1624
+ #
1625
+ # @!attribute [rw] security_group
1626
+ # Identifier of the security group that applies to the launched
1627
+ # server.
1628
+ # @return [String]
1629
+ #
1630
+ # @!attribute [rw] ec2_key_name
1631
+ # Name of the EC2 SSH Key to be used for connecting to the launched
1632
+ # server.
1633
+ # @return [String]
1634
+ #
1635
+ # @!attribute [rw] user_data
1636
+ # Location of the user-data script to be executed when launching the
1637
+ # server.
1638
+ # @return [Types::UserData]
1639
+ #
1640
+ # @!attribute [rw] instance_type
1641
+ # Instance type to be used for launching the server.
1642
+ # @return [String]
1643
+ #
1644
+ # @!attribute [rw] associate_public_ip_address
1645
+ # If true, a publicly accessible IP address is created when launching
1646
+ # the server.
1647
+ # @return [Boolean]
1648
+ #
1649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerLaunchConfiguration AWS API Documentation
1650
+ #
1651
+ class ServerLaunchConfiguration < Struct.new(
1652
+ :server,
1653
+ :logical_id,
1654
+ :vpc,
1655
+ :subnet,
1656
+ :security_group,
1657
+ :ec2_key_name,
1658
+ :user_data,
1659
+ :instance_type,
1660
+ :associate_public_ip_address)
1661
+ include Aws::Structure
1662
+ end
1663
+
1664
+ # Replication configuration of a server.
1665
+ #
1666
+ # @note When making an API call, you may pass ServerReplicationConfiguration
1667
+ # data as a hash:
1668
+ #
1669
+ # {
1670
+ # server: {
1671
+ # server_id: "ServerId",
1672
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1673
+ # vm_server: {
1674
+ # vm_server_address: {
1675
+ # vm_manager_id: "VmManagerId",
1676
+ # vm_id: "VmId",
1677
+ # },
1678
+ # vm_name: "VmName",
1679
+ # vm_manager_name: "VmManagerName",
1680
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1681
+ # vm_path: "VmPath",
1682
+ # },
1683
+ # replication_job_id: "ReplicationJobId",
1684
+ # replication_job_terminated: false,
1685
+ # },
1686
+ # server_replication_parameters: {
1687
+ # seed_time: Time.now,
1688
+ # frequency: 1,
1689
+ # run_once: false,
1690
+ # license_type: "AWS", # accepts AWS, BYOL
1691
+ # number_of_recent_amis_to_keep: 1,
1692
+ # encrypted: false,
1693
+ # kms_key_id: "KmsKeyId",
1694
+ # },
1695
+ # }
1696
+ #
1697
+ # @!attribute [rw] server
1698
+ # Identifier of the server this replication configuration is
1699
+ # associated with.
1700
+ # @return [Types::Server]
1701
+ #
1702
+ # @!attribute [rw] server_replication_parameters
1703
+ # Parameters for replicating the server.
1704
+ # @return [Types::ServerReplicationParameters]
1705
+ #
1706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerReplicationConfiguration AWS API Documentation
1707
+ #
1708
+ class ServerReplicationConfiguration < Struct.new(
1709
+ :server,
1710
+ :server_replication_parameters)
1711
+ include Aws::Structure
1712
+ end
1713
+
1714
+ # Replication parameters for replicating a server.
1715
+ #
1716
+ # @note When making an API call, you may pass ServerReplicationParameters
1717
+ # data as a hash:
1718
+ #
1719
+ # {
1720
+ # seed_time: Time.now,
1721
+ # frequency: 1,
1722
+ # run_once: false,
1723
+ # license_type: "AWS", # accepts AWS, BYOL
1724
+ # number_of_recent_amis_to_keep: 1,
1725
+ # encrypted: false,
1726
+ # kms_key_id: "KmsKeyId",
1727
+ # }
1728
+ #
1729
+ # @!attribute [rw] seed_time
1730
+ # Seed time for creating a replication job for the server.
1731
+ # @return [Time]
1732
+ #
1733
+ # @!attribute [rw] frequency
1734
+ # Frequency of creating replication jobs for the server.
1735
+ # @return [Integer]
1736
+ #
1737
+ # @!attribute [rw] run_once
1738
+ # @return [Boolean]
1739
+ #
1740
+ # @!attribute [rw] license_type
1741
+ # License type for creating a replication job for the server.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] number_of_recent_amis_to_keep
1745
+ # Number of recent AMIs to keep when creating a replication job for
1746
+ # this server.
1747
+ # @return [Integer]
1748
+ #
1749
+ # @!attribute [rw] encrypted
1750
+ # When true, the replication job produces encrypted AMIs. See also
1751
+ # `KmsKeyId` below.
1752
+ # @return [Boolean]
1753
+ #
1754
+ # @!attribute [rw] kms_key_id
1755
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
1756
+ # any of the following:
1757
+ #
1758
+ # * KMS key ID
1759
+ #
1760
+ # * KMS key alias
1761
+ #
1762
+ # * ARN referring to KMS key ID
1763
+ #
1764
+ # * ARN referring to KMS key alias
1765
+ #
1766
+ # If encrypted is *true* but a KMS key id is not specified, the
1767
+ # customer's default KMS key for EBS is used.
1768
+ # @return [String]
1769
+ #
1770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ServerReplicationParameters AWS API Documentation
1771
+ #
1772
+ class ServerReplicationParameters < Struct.new(
1773
+ :seed_time,
1774
+ :frequency,
1775
+ :run_once,
1776
+ :license_type,
1777
+ :number_of_recent_amis_to_keep,
1778
+ :encrypted,
1779
+ :kms_key_id)
1780
+ include Aws::Structure
1781
+ end
1782
+
1783
+ # @note When making an API call, you may pass StartAppReplicationRequest
1784
+ # data as a hash:
1785
+ #
1786
+ # {
1787
+ # app_id: "AppId",
1788
+ # }
1789
+ #
1790
+ # @!attribute [rw] app_id
1791
+ # ID of the application to replicate.
1792
+ # @return [String]
1793
+ #
1794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartAppReplicationRequest AWS API Documentation
1795
+ #
1796
+ class StartAppReplicationRequest < Struct.new(
1797
+ :app_id)
1798
+ include Aws::Structure
1799
+ end
1800
+
1801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartAppReplicationResponse AWS API Documentation
1802
+ #
1803
+ class StartAppReplicationResponse < Aws::EmptyStructure; end
1804
+
548
1805
  # @note When making an API call, you may pass StartOnDemandReplicationRunRequest
549
1806
  # data as a hash:
550
1807
  #
@@ -554,11 +1811,11 @@ module Aws::SMS
554
1811
  # }
555
1812
  #
556
1813
  # @!attribute [rw] replication_job_id
557
- # The unique identifier for a Replication Job.
1814
+ # The identifier of the replication job.
558
1815
  # @return [String]
559
1816
  #
560
1817
  # @!attribute [rw] description
561
- # The description for a Replication Job/Run.
1818
+ # The description of the replication run.
562
1819
  # @return [String]
563
1820
  #
564
1821
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRunRequest AWS API Documentation
@@ -570,7 +1827,7 @@ module Aws::SMS
570
1827
  end
571
1828
 
572
1829
  # @!attribute [rw] replication_run_id
573
- # The unique identifier for a Replication Run.
1830
+ # The identifier of the replication run.
574
1831
  # @return [String]
575
1832
  #
576
1833
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRunResponse AWS API Documentation
@@ -580,6 +1837,173 @@ module Aws::SMS
580
1837
  include Aws::Structure
581
1838
  end
582
1839
 
1840
+ # @note When making an API call, you may pass StopAppReplicationRequest
1841
+ # data as a hash:
1842
+ #
1843
+ # {
1844
+ # app_id: "AppId",
1845
+ # }
1846
+ #
1847
+ # @!attribute [rw] app_id
1848
+ # ID of the application to stop replicating.
1849
+ # @return [String]
1850
+ #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StopAppReplicationRequest AWS API Documentation
1852
+ #
1853
+ class StopAppReplicationRequest < Struct.new(
1854
+ :app_id)
1855
+ include Aws::Structure
1856
+ end
1857
+
1858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StopAppReplicationResponse AWS API Documentation
1859
+ #
1860
+ class StopAppReplicationResponse < Aws::EmptyStructure; end
1861
+
1862
+ # A label that can be assigned to an application.
1863
+ #
1864
+ # @note When making an API call, you may pass Tag
1865
+ # data as a hash:
1866
+ #
1867
+ # {
1868
+ # key: "TagKey",
1869
+ # value: "TagValue",
1870
+ # }
1871
+ #
1872
+ # @!attribute [rw] key
1873
+ # Tag key.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] value
1877
+ # Tag value.
1878
+ # @return [String]
1879
+ #
1880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/Tag AWS API Documentation
1881
+ #
1882
+ class Tag < Struct.new(
1883
+ :key,
1884
+ :value)
1885
+ include Aws::Structure
1886
+ end
1887
+
1888
+ # @note When making an API call, you may pass TerminateAppRequest
1889
+ # data as a hash:
1890
+ #
1891
+ # {
1892
+ # app_id: "AppId",
1893
+ # }
1894
+ #
1895
+ # @!attribute [rw] app_id
1896
+ # ID of the application to terminate.
1897
+ # @return [String]
1898
+ #
1899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/TerminateAppRequest AWS API Documentation
1900
+ #
1901
+ class TerminateAppRequest < Struct.new(
1902
+ :app_id)
1903
+ include Aws::Structure
1904
+ end
1905
+
1906
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/TerminateAppResponse AWS API Documentation
1907
+ #
1908
+ class TerminateAppResponse < Aws::EmptyStructure; end
1909
+
1910
+ # @note When making an API call, you may pass UpdateAppRequest
1911
+ # data as a hash:
1912
+ #
1913
+ # {
1914
+ # app_id: "AppId",
1915
+ # name: "AppName",
1916
+ # description: "AppDescription",
1917
+ # role_name: "RoleName",
1918
+ # server_groups: [
1919
+ # {
1920
+ # server_group_id: "ServerGroupId",
1921
+ # name: "ServerGroupName",
1922
+ # server_list: [
1923
+ # {
1924
+ # server_id: "ServerId",
1925
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1926
+ # vm_server: {
1927
+ # vm_server_address: {
1928
+ # vm_manager_id: "VmManagerId",
1929
+ # vm_id: "VmId",
1930
+ # },
1931
+ # vm_name: "VmName",
1932
+ # vm_manager_name: "VmManagerName",
1933
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1934
+ # vm_path: "VmPath",
1935
+ # },
1936
+ # replication_job_id: "ReplicationJobId",
1937
+ # replication_job_terminated: false,
1938
+ # },
1939
+ # ],
1940
+ # },
1941
+ # ],
1942
+ # tags: [
1943
+ # {
1944
+ # key: "TagKey",
1945
+ # value: "TagValue",
1946
+ # },
1947
+ # ],
1948
+ # }
1949
+ #
1950
+ # @!attribute [rw] app_id
1951
+ # ID of the application to update.
1952
+ # @return [String]
1953
+ #
1954
+ # @!attribute [rw] name
1955
+ # New name of the application.
1956
+ # @return [String]
1957
+ #
1958
+ # @!attribute [rw] description
1959
+ # New description of the application.
1960
+ # @return [String]
1961
+ #
1962
+ # @!attribute [rw] role_name
1963
+ # Name of the service role in the customer's account used by AWS SMS.
1964
+ # @return [String]
1965
+ #
1966
+ # @!attribute [rw] server_groups
1967
+ # List of server groups in the application to update.
1968
+ # @return [Array<Types::ServerGroup>]
1969
+ #
1970
+ # @!attribute [rw] tags
1971
+ # List of tags to associate with the application.
1972
+ # @return [Array<Types::Tag>]
1973
+ #
1974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateAppRequest AWS API Documentation
1975
+ #
1976
+ class UpdateAppRequest < Struct.new(
1977
+ :app_id,
1978
+ :name,
1979
+ :description,
1980
+ :role_name,
1981
+ :server_groups,
1982
+ :tags)
1983
+ include Aws::Structure
1984
+ end
1985
+
1986
+ # @!attribute [rw] app_summary
1987
+ # Summary description of the application.
1988
+ # @return [Types::AppSummary]
1989
+ #
1990
+ # @!attribute [rw] server_groups
1991
+ # List of updated server groups in the application.
1992
+ # @return [Array<Types::ServerGroup>]
1993
+ #
1994
+ # @!attribute [rw] tags
1995
+ # List of tags associated with the application.
1996
+ # @return [Array<Types::Tag>]
1997
+ #
1998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateAppResponse AWS API Documentation
1999
+ #
2000
+ class UpdateAppResponse < Struct.new(
2001
+ :app_summary,
2002
+ :server_groups,
2003
+ :tags)
2004
+ include Aws::Structure
2005
+ end
2006
+
583
2007
  # @note When making an API call, you may pass UpdateReplicationJobRequest
584
2008
  # data as a hash:
585
2009
  #
@@ -590,33 +2014,60 @@ module Aws::SMS
590
2014
  # license_type: "AWS", # accepts AWS, BYOL
591
2015
  # role_name: "RoleName",
592
2016
  # description: "Description",
2017
+ # number_of_recent_amis_to_keep: 1,
2018
+ # encrypted: false,
2019
+ # kms_key_id: "KmsKeyId",
593
2020
  # }
594
2021
  #
595
2022
  # @!attribute [rw] replication_job_id
596
- # The unique identifier for a Replication Job.
2023
+ # The identifier of the replication job.
597
2024
  # @return [String]
598
2025
  #
599
2026
  # @!attribute [rw] frequency
600
- # Interval between Replication Runs. This value is specified in hours,
601
- # and represents the time between consecutive Replication Runs.
2027
+ # The time between consecutive replication runs, in hours.
602
2028
  # @return [Integer]
603
2029
  #
604
2030
  # @!attribute [rw] next_replication_run_start_time
605
- # Timestamp of an operation
2031
+ # The start time of the next replication run.
606
2032
  # @return [Time]
607
2033
  #
608
2034
  # @!attribute [rw] license_type
609
- # The license type to be used for the Amazon Machine Image (AMI)
610
- # created after a successful ReplicationRun.
2035
+ # The license type to be used for the AMI created by a successful
2036
+ # replication run.
611
2037
  # @return [String]
612
2038
  #
613
2039
  # @!attribute [rw] role_name
614
- # Name of service role in customer's account to be used by SMS
615
- # service.
2040
+ # The name of the IAM role to be used by AWS SMS.
616
2041
  # @return [String]
617
2042
  #
618
2043
  # @!attribute [rw] description
619
- # The description for a Replication Job/Run.
2044
+ # The description of the replication job.
2045
+ # @return [String]
2046
+ #
2047
+ # @!attribute [rw] number_of_recent_amis_to_keep
2048
+ # The maximum number of SMS-created AMIs to retain. The oldest will be
2049
+ # deleted once the maximum number is reached and a new AMI is created.
2050
+ # @return [Integer]
2051
+ #
2052
+ # @!attribute [rw] encrypted
2053
+ # When true, the replication job produces encrypted AMIs . See also
2054
+ # `KmsKeyId` below.
2055
+ # @return [Boolean]
2056
+ #
2057
+ # @!attribute [rw] kms_key_id
2058
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
2059
+ # any of the following:
2060
+ #
2061
+ # * KMS key ID
2062
+ #
2063
+ # * KMS key alias
2064
+ #
2065
+ # * ARN referring to KMS key ID
2066
+ #
2067
+ # * ARN referring to KMS key alias
2068
+ #
2069
+ # If encrypted is *true* but a KMS key id is not specified, the
2070
+ # customer's default KMS key for EBS is used.
620
2071
  # @return [String]
621
2072
  #
622
2073
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJobRequest AWS API Documentation
@@ -627,7 +2078,10 @@ module Aws::SMS
627
2078
  :next_replication_run_start_time,
628
2079
  :license_type,
629
2080
  :role_name,
630
- :description)
2081
+ :description,
2082
+ :number_of_recent_amis_to_keep,
2083
+ :encrypted,
2084
+ :kms_key_id)
631
2085
  include Aws::Structure
632
2086
  end
633
2087
 
@@ -635,26 +2089,65 @@ module Aws::SMS
635
2089
  #
636
2090
  class UpdateReplicationJobResponse < Aws::EmptyStructure; end
637
2091
 
638
- # Object representing a VM server
2092
+ # A script that runs on first launch of an Amazon EC2 instance. Used for
2093
+ # configuring the server during launch.
2094
+ #
2095
+ # @note When making an API call, you may pass UserData
2096
+ # data as a hash:
2097
+ #
2098
+ # {
2099
+ # s3_location: {
2100
+ # bucket: "BucketName",
2101
+ # key: "KeyName",
2102
+ # },
2103
+ # }
2104
+ #
2105
+ # @!attribute [rw] s3_location
2106
+ # Amazon S3 location of the user-data script.
2107
+ # @return [Types::S3Location]
2108
+ #
2109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UserData AWS API Documentation
2110
+ #
2111
+ class UserData < Struct.new(
2112
+ :s3_location)
2113
+ include Aws::Structure
2114
+ end
2115
+
2116
+ # Represents a VM server.
2117
+ #
2118
+ # @note When making an API call, you may pass VmServer
2119
+ # data as a hash:
2120
+ #
2121
+ # {
2122
+ # vm_server_address: {
2123
+ # vm_manager_id: "VmManagerId",
2124
+ # vm_id: "VmId",
2125
+ # },
2126
+ # vm_name: "VmName",
2127
+ # vm_manager_name: "VmManagerName",
2128
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
2129
+ # vm_path: "VmPath",
2130
+ # }
639
2131
  #
640
2132
  # @!attribute [rw] vm_server_address
641
- # Object representing a server's location
2133
+ # Information about the VM server location.
642
2134
  # @return [Types::VmServerAddress]
643
2135
  #
644
2136
  # @!attribute [rw] vm_name
645
- # Name of Virtual Machine
2137
+ # The name of the VM.
646
2138
  # @return [String]
647
2139
  #
648
2140
  # @!attribute [rw] vm_manager_name
649
- # VM Manager Name
2141
+ # The name of the VM manager.
650
2142
  # @return [String]
651
2143
  #
652
2144
  # @!attribute [rw] vm_manager_type
653
- # VM Management Product
2145
+ # The type of VM management product.
654
2146
  # @return [String]
655
2147
  #
656
2148
  # @!attribute [rw] vm_path
657
- # Path to VM
2149
+ # The VM folder path in the vCenter Server virtual machine inventory
2150
+ # tree.
658
2151
  # @return [String]
659
2152
  #
660
2153
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/VmServer AWS API Documentation
@@ -668,14 +2161,22 @@ module Aws::SMS
668
2161
  include Aws::Structure
669
2162
  end
670
2163
 
671
- # Object representing a server's location
2164
+ # Represents a VM server location.
2165
+ #
2166
+ # @note When making an API call, you may pass VmServerAddress
2167
+ # data as a hash:
2168
+ #
2169
+ # {
2170
+ # vm_manager_id: "VmManagerId",
2171
+ # vm_id: "VmId",
2172
+ # }
672
2173
  #
673
2174
  # @!attribute [rw] vm_manager_id
674
- # Unique Identifier for VM Manager
2175
+ # The identifier of the VM manager.
675
2176
  # @return [String]
676
2177
  #
677
2178
  # @!attribute [rw] vm_id
678
- # Unique Identifier for a VM
2179
+ # The identifier of the VM.
679
2180
  # @return [String]
680
2181
  #
681
2182
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/VmServerAddress AWS API Documentation