aws-sdk-backupgateway 1.5.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backupgateway/client.rb +281 -3
- data/lib/aws-sdk-backupgateway/client_api.rb +186 -0
- data/lib/aws-sdk-backupgateway/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-backupgateway/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-backupgateway/endpoints.rb +365 -0
- data/lib/aws-sdk-backupgateway/plugins/endpoints.rb +118 -0
- data/lib/aws-sdk-backupgateway/types.rb +389 -176
- data/lib/aws-sdk-backupgateway.rb +5 -1
- metadata +8 -4
@@ -29,14 +29,6 @@ module Aws::BackupGateway
|
|
29
29
|
include Aws::Structure
|
30
30
|
end
|
31
31
|
|
32
|
-
# @note When making an API call, you may pass AssociateGatewayToServerInput
|
33
|
-
# data as a hash:
|
34
|
-
#
|
35
|
-
# {
|
36
|
-
# gateway_arn: "GatewayArn", # required
|
37
|
-
# server_arn: "ServerArn", # required
|
38
|
-
# }
|
39
|
-
#
|
40
32
|
# @!attribute [rw] gateway_arn
|
41
33
|
# The Amazon Resource Name (ARN) of the gateway. Use the
|
42
34
|
# `ListGateways` operation to return a list of gateways for your
|
@@ -69,6 +61,62 @@ module Aws::BackupGateway
|
|
69
61
|
include Aws::Structure
|
70
62
|
end
|
71
63
|
|
64
|
+
# Describes a bandwidth rate limit interval for a gateway. A bandwidth
|
65
|
+
# rate limit schedule consists of one or more bandwidth rate limit
|
66
|
+
# intervals. A bandwidth rate limit interval defines a period of time on
|
67
|
+
# one or more days of the week, during which bandwidth rate limits are
|
68
|
+
# specified for uploading, downloading, or both.
|
69
|
+
#
|
70
|
+
# @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
|
71
|
+
# The average upload rate limit component of the bandwidth rate limit
|
72
|
+
# interval, in bits per second. This field does not appear in the
|
73
|
+
# response if the upload rate limit is not set.
|
74
|
+
#
|
75
|
+
# <note markdown="1"> For Backup Gateway, the minimum value is `(Value)`.
|
76
|
+
#
|
77
|
+
# </note>
|
78
|
+
# @return [Integer]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] days_of_week
|
81
|
+
# The days of the week component of the bandwidth rate limit interval,
|
82
|
+
# represented as ordinal numbers from 0 to 6, where 0 represents
|
83
|
+
# Sunday and 6 represents Saturday.
|
84
|
+
# @return [Array<Integer>]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] end_hour_of_day
|
87
|
+
# The hour of the day to end the bandwidth rate limit interval.
|
88
|
+
# @return [Integer]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] end_minute_of_hour
|
91
|
+
# The minute of the hour to end the bandwidth rate limit interval.
|
92
|
+
#
|
93
|
+
# The bandwidth rate limit interval ends at the end of the minute. To
|
94
|
+
# end an interval at the end of an hour, use the value `59`.
|
95
|
+
# @return [Integer]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] start_hour_of_day
|
98
|
+
# The hour of the day to start the bandwidth rate limit interval.
|
99
|
+
# @return [Integer]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] start_minute_of_hour
|
102
|
+
# The minute of the hour to start the bandwidth rate limit interval.
|
103
|
+
# The interval begins at the start of that minute. To begin an
|
104
|
+
# interval exactly at the start of the hour, use the value `0`.
|
105
|
+
# @return [Integer]
|
106
|
+
#
|
107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/BandwidthRateLimitInterval AWS API Documentation
|
108
|
+
#
|
109
|
+
class BandwidthRateLimitInterval < Struct.new(
|
110
|
+
:average_upload_rate_limit_in_bits_per_sec,
|
111
|
+
:days_of_week,
|
112
|
+
:end_hour_of_day,
|
113
|
+
:end_minute_of_hour,
|
114
|
+
:start_hour_of_day,
|
115
|
+
:start_minute_of_hour)
|
116
|
+
SENSITIVE = []
|
117
|
+
include Aws::Structure
|
118
|
+
end
|
119
|
+
|
72
120
|
# The operation cannot proceed because it is not supported.
|
73
121
|
#
|
74
122
|
# @!attribute [rw] error_code
|
@@ -87,21 +135,6 @@ module Aws::BackupGateway
|
|
87
135
|
include Aws::Structure
|
88
136
|
end
|
89
137
|
|
90
|
-
# @note When making an API call, you may pass CreateGatewayInput
|
91
|
-
# data as a hash:
|
92
|
-
#
|
93
|
-
# {
|
94
|
-
# activation_key: "ActivationKey", # required
|
95
|
-
# gateway_display_name: "Name", # required
|
96
|
-
# gateway_type: "BACKUP_VM", # required, accepts BACKUP_VM
|
97
|
-
# tags: [
|
98
|
-
# {
|
99
|
-
# key: "TagKey", # required
|
100
|
-
# value: "TagValue", # required
|
101
|
-
# },
|
102
|
-
# ],
|
103
|
-
# }
|
104
|
-
#
|
105
138
|
# @!attribute [rw] activation_key
|
106
139
|
# The activation key of the created gateway.
|
107
140
|
# @return [String]
|
@@ -142,13 +175,6 @@ module Aws::BackupGateway
|
|
142
175
|
include Aws::Structure
|
143
176
|
end
|
144
177
|
|
145
|
-
# @note When making an API call, you may pass DeleteGatewayInput
|
146
|
-
# data as a hash:
|
147
|
-
#
|
148
|
-
# {
|
149
|
-
# gateway_arn: "GatewayArn", # required
|
150
|
-
# }
|
151
|
-
#
|
152
178
|
# @!attribute [rw] gateway_arn
|
153
179
|
# The Amazon Resource Name (ARN) of the gateway to delete.
|
154
180
|
# @return [String]
|
@@ -173,13 +199,6 @@ module Aws::BackupGateway
|
|
173
199
|
include Aws::Structure
|
174
200
|
end
|
175
201
|
|
176
|
-
# @note When making an API call, you may pass DeleteHypervisorInput
|
177
|
-
# data as a hash:
|
178
|
-
#
|
179
|
-
# {
|
180
|
-
# hypervisor_arn: "ServerArn", # required
|
181
|
-
# }
|
182
|
-
#
|
183
202
|
# @!attribute [rw] hypervisor_arn
|
184
203
|
# The Amazon Resource Name (ARN) of the hypervisor to delete.
|
185
204
|
# @return [String]
|
@@ -204,13 +223,6 @@ module Aws::BackupGateway
|
|
204
223
|
include Aws::Structure
|
205
224
|
end
|
206
225
|
|
207
|
-
# @note When making an API call, you may pass DisassociateGatewayFromServerInput
|
208
|
-
# data as a hash:
|
209
|
-
#
|
210
|
-
# {
|
211
|
-
# gateway_arn: "GatewayArn", # required
|
212
|
-
# }
|
213
|
-
#
|
214
226
|
# @!attribute [rw] gateway_arn
|
215
227
|
# The Amazon Resource Name (ARN) of the gateway to disassociate.
|
216
228
|
# @return [String]
|
@@ -329,13 +341,49 @@ module Aws::BackupGateway
|
|
329
341
|
include Aws::Structure
|
330
342
|
end
|
331
343
|
|
332
|
-
#
|
333
|
-
#
|
344
|
+
# @!attribute [rw] gateway_arn
|
345
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
346
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
347
|
+
# account and Amazon Web Services Region.
|
348
|
+
#
|
349
|
+
#
|
350
|
+
#
|
351
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
352
|
+
# @return [String]
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitScheduleInput AWS API Documentation
|
355
|
+
#
|
356
|
+
class GetBandwidthRateLimitScheduleInput < Struct.new(
|
357
|
+
:gateway_arn)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# @!attribute [rw] bandwidth_rate_limit_intervals
|
363
|
+
# An array containing bandwidth rate limit schedule intervals for a
|
364
|
+
# gateway. When no bandwidth rate limit intervals have been scheduled,
|
365
|
+
# the array is empty.
|
366
|
+
# @return [Array<Types::BandwidthRateLimitInterval>]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] gateway_arn
|
369
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
370
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
371
|
+
# account and Amazon Web Services Region.
|
372
|
+
#
|
373
|
+
#
|
334
374
|
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
375
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitScheduleOutput AWS API Documentation
|
338
379
|
#
|
380
|
+
class GetBandwidthRateLimitScheduleOutput < Struct.new(
|
381
|
+
:bandwidth_rate_limit_intervals,
|
382
|
+
:gateway_arn)
|
383
|
+
SENSITIVE = []
|
384
|
+
include Aws::Structure
|
385
|
+
end
|
386
|
+
|
339
387
|
# @!attribute [rw] gateway_arn
|
340
388
|
# The Amazon Resource Name (ARN) of the gateway.
|
341
389
|
# @return [String]
|
@@ -361,13 +409,65 @@ module Aws::BackupGateway
|
|
361
409
|
include Aws::Structure
|
362
410
|
end
|
363
411
|
|
364
|
-
#
|
365
|
-
#
|
412
|
+
# @!attribute [rw] hypervisor_arn
|
413
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
414
|
+
# @return [String]
|
366
415
|
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorInput AWS API Documentation
|
417
|
+
#
|
418
|
+
class GetHypervisorInput < Struct.new(
|
419
|
+
:hypervisor_arn)
|
420
|
+
SENSITIVE = []
|
421
|
+
include Aws::Structure
|
422
|
+
end
|
423
|
+
|
424
|
+
# @!attribute [rw] hypervisor
|
425
|
+
# Details about the requested hypervisor.
|
426
|
+
# @return [Types::HypervisorDetails]
|
370
427
|
#
|
428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorOutput AWS API Documentation
|
429
|
+
#
|
430
|
+
class GetHypervisorOutput < Struct.new(
|
431
|
+
:hypervisor)
|
432
|
+
SENSITIVE = []
|
433
|
+
include Aws::Structure
|
434
|
+
end
|
435
|
+
|
436
|
+
# @!attribute [rw] hypervisor_arn
|
437
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
438
|
+
# @return [String]
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappingsInput AWS API Documentation
|
441
|
+
#
|
442
|
+
class GetHypervisorPropertyMappingsInput < Struct.new(
|
443
|
+
:hypervisor_arn)
|
444
|
+
SENSITIVE = []
|
445
|
+
include Aws::Structure
|
446
|
+
end
|
447
|
+
|
448
|
+
# @!attribute [rw] hypervisor_arn
|
449
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] iam_role_arn
|
453
|
+
# The Amazon Resource Name (ARN) of the IAM role.
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] vmware_to_aws_tag_mappings
|
457
|
+
# This is a display of the mappings of on-premises VMware tags to the
|
458
|
+
# Amazon Web Services tags.
|
459
|
+
# @return [Array<Types::VmwareToAwsTagMapping>]
|
460
|
+
#
|
461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappingsOutput AWS API Documentation
|
462
|
+
#
|
463
|
+
class GetHypervisorPropertyMappingsOutput < Struct.new(
|
464
|
+
:hypervisor_arn,
|
465
|
+
:iam_role_arn,
|
466
|
+
:vmware_to_aws_tag_mappings)
|
467
|
+
SENSITIVE = []
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
371
471
|
# @!attribute [rw] resource_arn
|
372
472
|
# The Amazon Resource Name (ARN) of the virtual machine.
|
373
473
|
# @return [String]
|
@@ -433,23 +533,68 @@ module Aws::BackupGateway
|
|
433
533
|
include Aws::Structure
|
434
534
|
end
|
435
535
|
|
436
|
-
#
|
437
|
-
#
|
536
|
+
# These are the details of the specified hypervisor. A hypervisor is
|
537
|
+
# hardware, software, or firmware that creates and manages virtual
|
538
|
+
# machines, and allocates resources to them.
|
438
539
|
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
# password: "Password",
|
444
|
-
# tags: [
|
445
|
-
# {
|
446
|
-
# key: "TagKey", # required
|
447
|
-
# value: "TagValue", # required
|
448
|
-
# },
|
449
|
-
# ],
|
450
|
-
# username: "Username",
|
451
|
-
# }
|
540
|
+
# @!attribute [rw] host
|
541
|
+
# The server host of the hypervisor. This can be either an IP address
|
542
|
+
# or a fully-qualified domain name (FQDN).
|
543
|
+
# @return [String]
|
452
544
|
#
|
545
|
+
# @!attribute [rw] hypervisor_arn
|
546
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] kms_key_arn
|
550
|
+
# The Amazon Resource Name (ARN) of the KMS used to encrypt the
|
551
|
+
# hypervisor.
|
552
|
+
# @return [String]
|
553
|
+
#
|
554
|
+
# @!attribute [rw] last_successful_metadata_sync_time
|
555
|
+
# This is the time when the most recent successful sync of metadata
|
556
|
+
# occurred.
|
557
|
+
# @return [Time]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] latest_metadata_sync_status
|
560
|
+
# This is the most recent status for the indicated metadata sync.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] latest_metadata_sync_status_message
|
564
|
+
# This is the most recent status for the indicated metadata sync.
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] log_group_arn
|
568
|
+
# The Amazon Resource Name (ARN) of the group of gateways within the
|
569
|
+
# requested log.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] name
|
573
|
+
# This is the name of the specified hypervisor.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] state
|
577
|
+
# This is the current state of the specified hypervisor.
|
578
|
+
#
|
579
|
+
# The possible states are `PENDING`, `ONLINE`, `OFFLINE`, or `ERROR`.
|
580
|
+
# @return [String]
|
581
|
+
#
|
582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/HypervisorDetails AWS API Documentation
|
583
|
+
#
|
584
|
+
class HypervisorDetails < Struct.new(
|
585
|
+
:host,
|
586
|
+
:hypervisor_arn,
|
587
|
+
:kms_key_arn,
|
588
|
+
:last_successful_metadata_sync_time,
|
589
|
+
:latest_metadata_sync_status,
|
590
|
+
:latest_metadata_sync_status_message,
|
591
|
+
:log_group_arn,
|
592
|
+
:name,
|
593
|
+
:state)
|
594
|
+
SENSITIVE = []
|
595
|
+
include Aws::Structure
|
596
|
+
end
|
597
|
+
|
453
598
|
# @!attribute [rw] host
|
454
599
|
# The server host of the hypervisor. This can be either an IP address
|
455
600
|
# or a fully-qualified domain name (FQDN).
|
@@ -519,14 +664,6 @@ module Aws::BackupGateway
|
|
519
664
|
include Aws::Structure
|
520
665
|
end
|
521
666
|
|
522
|
-
# @note When making an API call, you may pass ListGatewaysInput
|
523
|
-
# data as a hash:
|
524
|
-
#
|
525
|
-
# {
|
526
|
-
# max_results: 1,
|
527
|
-
# next_token: "NextToken",
|
528
|
-
# }
|
529
|
-
#
|
530
667
|
# @!attribute [rw] max_results
|
531
668
|
# The maximum number of gateways to list.
|
532
669
|
# @return [Integer]
|
@@ -567,14 +704,6 @@ module Aws::BackupGateway
|
|
567
704
|
include Aws::Structure
|
568
705
|
end
|
569
706
|
|
570
|
-
# @note When making an API call, you may pass ListHypervisorsInput
|
571
|
-
# data as a hash:
|
572
|
-
#
|
573
|
-
# {
|
574
|
-
# max_results: 1,
|
575
|
-
# next_token: "NextToken",
|
576
|
-
# }
|
577
|
-
#
|
578
707
|
# @!attribute [rw] max_results
|
579
708
|
# The maximum number of hypervisors to list.
|
580
709
|
# @return [Integer]
|
@@ -616,13 +745,6 @@ module Aws::BackupGateway
|
|
616
745
|
include Aws::Structure
|
617
746
|
end
|
618
747
|
|
619
|
-
# @note When making an API call, you may pass ListTagsForResourceInput
|
620
|
-
# data as a hash:
|
621
|
-
#
|
622
|
-
# {
|
623
|
-
# resource_arn: "ResourceArn", # required
|
624
|
-
# }
|
625
|
-
#
|
626
748
|
# @!attribute [rw] resource_arn
|
627
749
|
# The Amazon Resource Name (ARN) of the resource's tags to list.
|
628
750
|
# @return [String]
|
@@ -653,15 +775,6 @@ module Aws::BackupGateway
|
|
653
775
|
include Aws::Structure
|
654
776
|
end
|
655
777
|
|
656
|
-
# @note When making an API call, you may pass ListVirtualMachinesInput
|
657
|
-
# data as a hash:
|
658
|
-
#
|
659
|
-
# {
|
660
|
-
# hypervisor_arn: "ServerArn",
|
661
|
-
# max_results: 1,
|
662
|
-
# next_token: "NextToken",
|
663
|
-
# }
|
664
|
-
#
|
665
778
|
# @!attribute [rw] hypervisor_arn
|
666
779
|
# The Amazon Resource Name (ARN) of the hypervisor connected to your
|
667
780
|
# virtual machine.
|
@@ -749,17 +862,84 @@ module Aws::BackupGateway
|
|
749
862
|
include Aws::Structure
|
750
863
|
end
|
751
864
|
|
752
|
-
#
|
753
|
-
#
|
865
|
+
# @!attribute [rw] bandwidth_rate_limit_intervals
|
866
|
+
# An array containing bandwidth rate limit schedule intervals for a
|
867
|
+
# gateway. When no bandwidth rate limit intervals have been scheduled,
|
868
|
+
# the array is empty.
|
869
|
+
# @return [Array<Types::BandwidthRateLimitInterval>]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] gateway_arn
|
872
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
873
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
874
|
+
# account and Amazon Web Services Region.
|
875
|
+
#
|
876
|
+
#
|
877
|
+
#
|
878
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
879
|
+
# @return [String]
|
880
|
+
#
|
881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitScheduleInput AWS API Documentation
|
882
|
+
#
|
883
|
+
class PutBandwidthRateLimitScheduleInput < Struct.new(
|
884
|
+
:bandwidth_rate_limit_intervals,
|
885
|
+
:gateway_arn)
|
886
|
+
SENSITIVE = []
|
887
|
+
include Aws::Structure
|
888
|
+
end
|
889
|
+
|
890
|
+
# @!attribute [rw] gateway_arn
|
891
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
892
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
893
|
+
# account and Amazon Web Services Region.
|
894
|
+
#
|
895
|
+
#
|
896
|
+
#
|
897
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
898
|
+
# @return [String]
|
754
899
|
#
|
755
|
-
#
|
756
|
-
# day_of_month: 1,
|
757
|
-
# day_of_week: 1,
|
758
|
-
# gateway_arn: "GatewayArn", # required
|
759
|
-
# hour_of_day: 1, # required
|
760
|
-
# minute_of_hour: 1, # required
|
761
|
-
# }
|
900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitScheduleOutput AWS API Documentation
|
762
901
|
#
|
902
|
+
class PutBandwidthRateLimitScheduleOutput < Struct.new(
|
903
|
+
:gateway_arn)
|
904
|
+
SENSITIVE = []
|
905
|
+
include Aws::Structure
|
906
|
+
end
|
907
|
+
|
908
|
+
# @!attribute [rw] hypervisor_arn
|
909
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] iam_role_arn
|
913
|
+
# The Amazon Resource Name (ARN) of the IAM role.
|
914
|
+
# @return [String]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] vmware_to_aws_tag_mappings
|
917
|
+
# This action requests the mappings of on-premises VMware tags to the
|
918
|
+
# Amazon Web Services tags.
|
919
|
+
# @return [Array<Types::VmwareToAwsTagMapping>]
|
920
|
+
#
|
921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappingsInput AWS API Documentation
|
922
|
+
#
|
923
|
+
class PutHypervisorPropertyMappingsInput < Struct.new(
|
924
|
+
:hypervisor_arn,
|
925
|
+
:iam_role_arn,
|
926
|
+
:vmware_to_aws_tag_mappings)
|
927
|
+
SENSITIVE = []
|
928
|
+
include Aws::Structure
|
929
|
+
end
|
930
|
+
|
931
|
+
# @!attribute [rw] hypervisor_arn
|
932
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappingsOutput AWS API Documentation
|
936
|
+
#
|
937
|
+
class PutHypervisorPropertyMappingsOutput < Struct.new(
|
938
|
+
:hypervisor_arn)
|
939
|
+
SENSITIVE = []
|
940
|
+
include Aws::Structure
|
941
|
+
end
|
942
|
+
|
763
943
|
# @!attribute [rw] day_of_month
|
764
944
|
# The day of the month start maintenance on a gateway.
|
765
945
|
#
|
@@ -826,18 +1006,34 @@ module Aws::BackupGateway
|
|
826
1006
|
include Aws::Structure
|
827
1007
|
end
|
828
1008
|
|
1009
|
+
# @!attribute [rw] hypervisor_arn
|
1010
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1011
|
+
# @return [String]
|
1012
|
+
#
|
1013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSyncInput AWS API Documentation
|
1014
|
+
#
|
1015
|
+
class StartVirtualMachinesMetadataSyncInput < Struct.new(
|
1016
|
+
:hypervisor_arn)
|
1017
|
+
SENSITIVE = []
|
1018
|
+
include Aws::Structure
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# @!attribute [rw] hypervisor_arn
|
1022
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSyncOutput AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class StartVirtualMachinesMetadataSyncOutput < Struct.new(
|
1028
|
+
:hypervisor_arn)
|
1029
|
+
SENSITIVE = []
|
1030
|
+
include Aws::Structure
|
1031
|
+
end
|
1032
|
+
|
829
1033
|
# A key-value pair you can use to manage, filter, and search for your
|
830
1034
|
# resources. Allowed characters include UTF-8 letters, numbers, spaces,
|
831
1035
|
# and the following characters: + - = . \_ : /.
|
832
1036
|
#
|
833
|
-
# @note When making an API call, you may pass Tag
|
834
|
-
# data as a hash:
|
835
|
-
#
|
836
|
-
# {
|
837
|
-
# key: "TagKey", # required
|
838
|
-
# value: "TagValue", # required
|
839
|
-
# }
|
840
|
-
#
|
841
1037
|
# @!attribute [rw] key
|
842
1038
|
# The key part of a tag's key-value pair. The key can't start with
|
843
1039
|
# `aws:`.
|
@@ -856,19 +1052,6 @@ module Aws::BackupGateway
|
|
856
1052
|
include Aws::Structure
|
857
1053
|
end
|
858
1054
|
|
859
|
-
# @note When making an API call, you may pass TagResourceInput
|
860
|
-
# data as a hash:
|
861
|
-
#
|
862
|
-
# {
|
863
|
-
# resource_arn: "ResourceArn", # required
|
864
|
-
# tags: [ # required
|
865
|
-
# {
|
866
|
-
# key: "TagKey", # required
|
867
|
-
# value: "TagValue", # required
|
868
|
-
# },
|
869
|
-
# ],
|
870
|
-
# }
|
871
|
-
#
|
872
1055
|
# @!attribute [rw] resource_arn
|
873
1056
|
# The Amazon Resource Name (ARN) of the resource to tag.
|
874
1057
|
# @return [String]
|
@@ -898,16 +1081,6 @@ module Aws::BackupGateway
|
|
898
1081
|
include Aws::Structure
|
899
1082
|
end
|
900
1083
|
|
901
|
-
# @note When making an API call, you may pass TestHypervisorConfigurationInput
|
902
|
-
# data as a hash:
|
903
|
-
#
|
904
|
-
# {
|
905
|
-
# gateway_arn: "GatewayArn", # required
|
906
|
-
# host: "Host", # required
|
907
|
-
# password: "Password",
|
908
|
-
# username: "Username",
|
909
|
-
# }
|
910
|
-
#
|
911
1084
|
# @!attribute [rw] gateway_arn
|
912
1085
|
# The Amazon Resource Name (ARN) of the gateway to the hypervisor to
|
913
1086
|
# test.
|
@@ -961,14 +1134,6 @@ module Aws::BackupGateway
|
|
961
1134
|
include Aws::Structure
|
962
1135
|
end
|
963
1136
|
|
964
|
-
# @note When making an API call, you may pass UntagResourceInput
|
965
|
-
# data as a hash:
|
966
|
-
#
|
967
|
-
# {
|
968
|
-
# resource_arn: "ResourceArn", # required
|
969
|
-
# tag_keys: ["TagKey"], # required
|
970
|
-
# }
|
971
|
-
#
|
972
1137
|
# @!attribute [rw] resource_arn
|
973
1138
|
# The Amazon Resource Name (ARN) of the resource from which to remove
|
974
1139
|
# tags.
|
@@ -1000,14 +1165,6 @@ module Aws::BackupGateway
|
|
1000
1165
|
include Aws::Structure
|
1001
1166
|
end
|
1002
1167
|
|
1003
|
-
# @note When making an API call, you may pass UpdateGatewayInformationInput
|
1004
|
-
# data as a hash:
|
1005
|
-
#
|
1006
|
-
# {
|
1007
|
-
# gateway_arn: "GatewayArn", # required
|
1008
|
-
# gateway_display_name: "Name",
|
1009
|
-
# }
|
1010
|
-
#
|
1011
1168
|
# @!attribute [rw] gateway_arn
|
1012
1169
|
# The Amazon Resource Name (ARN) of the gateway to update.
|
1013
1170
|
# @return [String]
|
@@ -1037,13 +1194,6 @@ module Aws::BackupGateway
|
|
1037
1194
|
include Aws::Structure
|
1038
1195
|
end
|
1039
1196
|
|
1040
|
-
# @note When making an API call, you may pass UpdateGatewaySoftwareNowInput
|
1041
|
-
# data as a hash:
|
1042
|
-
#
|
1043
|
-
# {
|
1044
|
-
# gateway_arn: "GatewayArn", # required
|
1045
|
-
# }
|
1046
|
-
#
|
1047
1197
|
# @!attribute [rw] gateway_arn
|
1048
1198
|
# The Amazon Resource Name (ARN) of the gateway to be updated.
|
1049
1199
|
# @return [String]
|
@@ -1068,17 +1218,6 @@ module Aws::BackupGateway
|
|
1068
1218
|
include Aws::Structure
|
1069
1219
|
end
|
1070
1220
|
|
1071
|
-
# @note When making an API call, you may pass UpdateHypervisorInput
|
1072
|
-
# data as a hash:
|
1073
|
-
#
|
1074
|
-
# {
|
1075
|
-
# host: "Host",
|
1076
|
-
# hypervisor_arn: "ServerArn", # required
|
1077
|
-
# name: "Name",
|
1078
|
-
# password: "Password",
|
1079
|
-
# username: "Username",
|
1080
|
-
# }
|
1081
|
-
#
|
1082
1221
|
# @!attribute [rw] host
|
1083
1222
|
# The updated host of the hypervisor. This can be either an IP address
|
1084
1223
|
# or a fully-qualified domain name (FQDN).
|
@@ -1088,6 +1227,11 @@ module Aws::BackupGateway
|
|
1088
1227
|
# The Amazon Resource Name (ARN) of the hypervisor to update.
|
1089
1228
|
# @return [String]
|
1090
1229
|
#
|
1230
|
+
# @!attribute [rw] log_group_arn
|
1231
|
+
# The Amazon Resource Name (ARN) of the group of gateways within the
|
1232
|
+
# requested log.
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
1091
1235
|
# @!attribute [rw] name
|
1092
1236
|
# The updated name for the hypervisor
|
1093
1237
|
# @return [String]
|
@@ -1105,6 +1249,7 @@ module Aws::BackupGateway
|
|
1105
1249
|
class UpdateHypervisorInput < Struct.new(
|
1106
1250
|
:host,
|
1107
1251
|
:hypervisor_arn,
|
1252
|
+
:log_group_arn,
|
1108
1253
|
:name,
|
1109
1254
|
:password,
|
1110
1255
|
:username)
|
@@ -1212,6 +1357,11 @@ module Aws::BackupGateway
|
|
1212
1357
|
# `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
|
1213
1358
|
# @return [String]
|
1214
1359
|
#
|
1360
|
+
# @!attribute [rw] vmware_tags
|
1361
|
+
# These are the details of the VMware tags associated with the
|
1362
|
+
# specified virtual machine.
|
1363
|
+
# @return [Array<Types::VmwareTag>]
|
1364
|
+
#
|
1215
1365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VirtualMachineDetails AWS API Documentation
|
1216
1366
|
#
|
1217
1367
|
class VirtualMachineDetails < Struct.new(
|
@@ -1220,7 +1370,70 @@ module Aws::BackupGateway
|
|
1220
1370
|
:last_backup_date,
|
1221
1371
|
:name,
|
1222
1372
|
:path,
|
1223
|
-
:resource_arn
|
1373
|
+
:resource_arn,
|
1374
|
+
:vmware_tags)
|
1375
|
+
SENSITIVE = []
|
1376
|
+
include Aws::Structure
|
1377
|
+
end
|
1378
|
+
|
1379
|
+
# A VMware tag is a tag attached to a specific virtual machine. A
|
1380
|
+
# [tag][1] is a key-value pair you can use to manage, filter, and search
|
1381
|
+
# for your resources.
|
1382
|
+
#
|
1383
|
+
# The content of VMware tags can be matched to Amazon Web Services tags.
|
1384
|
+
#
|
1385
|
+
#
|
1386
|
+
#
|
1387
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html
|
1388
|
+
#
|
1389
|
+
# @!attribute [rw] vmware_category
|
1390
|
+
# The is the category of VMware.
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @!attribute [rw] vmware_tag_description
|
1394
|
+
# This is a user-defined description of a VMware tag.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] vmware_tag_name
|
1398
|
+
# This is the user-defined name of a VMware tag.
|
1399
|
+
# @return [String]
|
1400
|
+
#
|
1401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VmwareTag AWS API Documentation
|
1402
|
+
#
|
1403
|
+
class VmwareTag < Struct.new(
|
1404
|
+
:vmware_category,
|
1405
|
+
:vmware_tag_description,
|
1406
|
+
:vmware_tag_name)
|
1407
|
+
SENSITIVE = []
|
1408
|
+
include Aws::Structure
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
# This displays the mapping of on-premises VMware tags to the
|
1412
|
+
# corresponding Amazon Web Services tags.
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] aws_tag_key
|
1415
|
+
# The key part of the Amazon Web Services tag's key-value pair.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] aws_tag_value
|
1419
|
+
# The value part of the Amazon Web Services tag's key-value pair.
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] vmware_category
|
1423
|
+
# The is the category of VMware.
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @!attribute [rw] vmware_tag_name
|
1427
|
+
# This is the user-defined name of a VMware tag.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VmwareToAwsTagMapping AWS API Documentation
|
1431
|
+
#
|
1432
|
+
class VmwareToAwsTagMapping < Struct.new(
|
1433
|
+
:aws_tag_key,
|
1434
|
+
:aws_tag_value,
|
1435
|
+
:vmware_category,
|
1436
|
+
:vmware_tag_name)
|
1224
1437
|
SENSITIVE = []
|
1225
1438
|
include Aws::Structure
|
1226
1439
|
end
|