aws-sdk-backupgateway 1.6.0 → 1.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backupgateway/client.rb +262 -1
- data/lib/aws-sdk-backupgateway/client_api.rb +186 -0
- data/lib/aws-sdk-backupgateway/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-backupgateway/endpoint_provider.rb +73 -74
- data/lib/aws-sdk-backupgateway/endpoints.rb +84 -0
- data/lib/aws-sdk-backupgateway/plugins/endpoints.rb +12 -0
- data/lib/aws-sdk-backupgateway/types.rb +389 -176
- data/lib/aws-sdk-backupgateway.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0a33cff8589a66fa385fd8350ddf5ee151b1ae1fa8748edf9acb7fa3b7596733
|
4
|
+
data.tar.gz: 317217c14f8080bbac7b2f8fcfa3eb6d54f57a398a9509a5d9de4228ee9921c7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eadcae087ea0145f77b68400faecc80d89bc7ef4bef5f302282d2b9ae52b88d870c546813fe7696235a04c140ae6cb30026a2356725c02823922670e37918ae0
|
7
|
+
data.tar.gz: ec48a8c76de448fedf7be8bd2084033c9b7bb487ae6fb48404b8ec93bc1c33c3e7e0d81c89b0532947c61f50259c044ff7703555e3ed554eb6c9493bec031002
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.7.0 (2022-12-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for VMware vSphere tags, enabling customer to protect VMware virtual machines using tag-based policies for AWS tags mapped from vSphere tags. This release also adds support for customer-accessible gateway-hypervisor interaction log and upload bandwidth rate limit schedule.
|
8
|
+
|
4
9
|
1.6.0 (2022-10-25)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.7.0
|
@@ -549,6 +549,52 @@ module Aws::BackupGateway
|
|
549
549
|
req.send_request(options)
|
550
550
|
end
|
551
551
|
|
552
|
+
# Retrieves the bandwidth rate limit schedule for a specified gateway.
|
553
|
+
# By default, gateways do not have bandwidth rate limit schedules, which
|
554
|
+
# means no bandwidth rate limiting is in effect. Use this to get a
|
555
|
+
# gateway's bandwidth rate limit schedule.
|
556
|
+
#
|
557
|
+
# @option params [required, String] :gateway_arn
|
558
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
559
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
560
|
+
# account and Amazon Web Services Region.
|
561
|
+
#
|
562
|
+
#
|
563
|
+
#
|
564
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
565
|
+
#
|
566
|
+
# @return [Types::GetBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
567
|
+
#
|
568
|
+
# * {Types::GetBandwidthRateLimitScheduleOutput#bandwidth_rate_limit_intervals #bandwidth_rate_limit_intervals} => Array<Types::BandwidthRateLimitInterval>
|
569
|
+
# * {Types::GetBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
|
570
|
+
#
|
571
|
+
# @example Request syntax with placeholder values
|
572
|
+
#
|
573
|
+
# resp = client.get_bandwidth_rate_limit_schedule({
|
574
|
+
# gateway_arn: "GatewayArn", # required
|
575
|
+
# })
|
576
|
+
#
|
577
|
+
# @example Response structure
|
578
|
+
#
|
579
|
+
# resp.bandwidth_rate_limit_intervals #=> Array
|
580
|
+
# resp.bandwidth_rate_limit_intervals[0].average_upload_rate_limit_in_bits_per_sec #=> Integer
|
581
|
+
# resp.bandwidth_rate_limit_intervals[0].days_of_week #=> Array
|
582
|
+
# resp.bandwidth_rate_limit_intervals[0].days_of_week[0] #=> Integer
|
583
|
+
# resp.bandwidth_rate_limit_intervals[0].end_hour_of_day #=> Integer
|
584
|
+
# resp.bandwidth_rate_limit_intervals[0].end_minute_of_hour #=> Integer
|
585
|
+
# resp.bandwidth_rate_limit_intervals[0].start_hour_of_day #=> Integer
|
586
|
+
# resp.bandwidth_rate_limit_intervals[0].start_minute_of_hour #=> Integer
|
587
|
+
# resp.gateway_arn #=> String
|
588
|
+
#
|
589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule AWS API Documentation
|
590
|
+
#
|
591
|
+
# @overload get_bandwidth_rate_limit_schedule(params = {})
|
592
|
+
# @param [Hash] params ({})
|
593
|
+
def get_bandwidth_rate_limit_schedule(params = {}, options = {})
|
594
|
+
req = build_request(:get_bandwidth_rate_limit_schedule, params)
|
595
|
+
req.send_request(options)
|
596
|
+
end
|
597
|
+
|
552
598
|
# By providing the ARN (Amazon Resource Name), this API returns the
|
553
599
|
# gateway.
|
554
600
|
#
|
@@ -588,6 +634,84 @@ module Aws::BackupGateway
|
|
588
634
|
req.send_request(options)
|
589
635
|
end
|
590
636
|
|
637
|
+
# This action requests information about the specified hypervisor to
|
638
|
+
# which the gateway will connect. A hypervisor is hardware, software, or
|
639
|
+
# firmware that creates and manages virtual machines, and allocates
|
640
|
+
# resources to them.
|
641
|
+
#
|
642
|
+
# @option params [required, String] :hypervisor_arn
|
643
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
644
|
+
#
|
645
|
+
# @return [Types::GetHypervisorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
646
|
+
#
|
647
|
+
# * {Types::GetHypervisorOutput#hypervisor #hypervisor} => Types::HypervisorDetails
|
648
|
+
#
|
649
|
+
# @example Request syntax with placeholder values
|
650
|
+
#
|
651
|
+
# resp = client.get_hypervisor({
|
652
|
+
# hypervisor_arn: "ServerArn", # required
|
653
|
+
# })
|
654
|
+
#
|
655
|
+
# @example Response structure
|
656
|
+
#
|
657
|
+
# resp.hypervisor.host #=> String
|
658
|
+
# resp.hypervisor.hypervisor_arn #=> String
|
659
|
+
# resp.hypervisor.kms_key_arn #=> String
|
660
|
+
# resp.hypervisor.last_successful_metadata_sync_time #=> Time
|
661
|
+
# resp.hypervisor.latest_metadata_sync_status #=> String, one of "CREATED", "RUNNING", "FAILED", "PARTIALLY_FAILED", "SUCCEEDED"
|
662
|
+
# resp.hypervisor.latest_metadata_sync_status_message #=> String
|
663
|
+
# resp.hypervisor.log_group_arn #=> String
|
664
|
+
# resp.hypervisor.name #=> String
|
665
|
+
# resp.hypervisor.state #=> String, one of "PENDING", "ONLINE", "OFFLINE", "ERROR"
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisor AWS API Documentation
|
668
|
+
#
|
669
|
+
# @overload get_hypervisor(params = {})
|
670
|
+
# @param [Hash] params ({})
|
671
|
+
def get_hypervisor(params = {}, options = {})
|
672
|
+
req = build_request(:get_hypervisor, params)
|
673
|
+
req.send_request(options)
|
674
|
+
end
|
675
|
+
|
676
|
+
# This action retrieves the property mappings for the specified
|
677
|
+
# hypervisor. A hypervisor property mapping displays the relationship of
|
678
|
+
# entity properties available from the on-premises hypervisor to the
|
679
|
+
# properties available in Amazon Web Services.
|
680
|
+
#
|
681
|
+
# @option params [required, String] :hypervisor_arn
|
682
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
683
|
+
#
|
684
|
+
# @return [Types::GetHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
685
|
+
#
|
686
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
|
687
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#iam_role_arn #iam_role_arn} => String
|
688
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#vmware_to_aws_tag_mappings #vmware_to_aws_tag_mappings} => Array<Types::VmwareToAwsTagMapping>
|
689
|
+
#
|
690
|
+
# @example Request syntax with placeholder values
|
691
|
+
#
|
692
|
+
# resp = client.get_hypervisor_property_mappings({
|
693
|
+
# hypervisor_arn: "ServerArn", # required
|
694
|
+
# })
|
695
|
+
#
|
696
|
+
# @example Response structure
|
697
|
+
#
|
698
|
+
# resp.hypervisor_arn #=> String
|
699
|
+
# resp.iam_role_arn #=> String
|
700
|
+
# resp.vmware_to_aws_tag_mappings #=> Array
|
701
|
+
# resp.vmware_to_aws_tag_mappings[0].aws_tag_key #=> String
|
702
|
+
# resp.vmware_to_aws_tag_mappings[0].aws_tag_value #=> String
|
703
|
+
# resp.vmware_to_aws_tag_mappings[0].vmware_category #=> String
|
704
|
+
# resp.vmware_to_aws_tag_mappings[0].vmware_tag_name #=> String
|
705
|
+
#
|
706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings AWS API Documentation
|
707
|
+
#
|
708
|
+
# @overload get_hypervisor_property_mappings(params = {})
|
709
|
+
# @param [Hash] params ({})
|
710
|
+
def get_hypervisor_property_mappings(params = {}, options = {})
|
711
|
+
req = build_request(:get_hypervisor_property_mappings, params)
|
712
|
+
req.send_request(options)
|
713
|
+
end
|
714
|
+
|
591
715
|
# By providing the ARN (Amazon Resource Name), this API returns the
|
592
716
|
# virtual machine.
|
593
717
|
#
|
@@ -612,6 +736,10 @@ module Aws::BackupGateway
|
|
612
736
|
# resp.virtual_machine.name #=> String
|
613
737
|
# resp.virtual_machine.path #=> String
|
614
738
|
# resp.virtual_machine.resource_arn #=> String
|
739
|
+
# resp.virtual_machine.vmware_tags #=> Array
|
740
|
+
# resp.virtual_machine.vmware_tags[0].vmware_category #=> String
|
741
|
+
# resp.virtual_machine.vmware_tags[0].vmware_tag_description #=> String
|
742
|
+
# resp.virtual_machine.vmware_tags[0].vmware_tag_name #=> String
|
615
743
|
#
|
616
744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachine AWS API Documentation
|
617
745
|
#
|
@@ -849,6 +977,105 @@ module Aws::BackupGateway
|
|
849
977
|
req.send_request(options)
|
850
978
|
end
|
851
979
|
|
980
|
+
# This action sets the bandwidth rate limit schedule for a specified
|
981
|
+
# gateway. By default, gateways do not have a bandwidth rate limit
|
982
|
+
# schedule, which means no bandwidth rate limiting is in effect. Use
|
983
|
+
# this to initiate a gateway's bandwidth rate limit schedule.
|
984
|
+
#
|
985
|
+
# @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
|
986
|
+
# An array containing bandwidth rate limit schedule intervals for a
|
987
|
+
# gateway. When no bandwidth rate limit intervals have been scheduled,
|
988
|
+
# the array is empty.
|
989
|
+
#
|
990
|
+
# @option params [required, String] :gateway_arn
|
991
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
992
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
993
|
+
# account and Amazon Web Services Region.
|
994
|
+
#
|
995
|
+
#
|
996
|
+
#
|
997
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
998
|
+
#
|
999
|
+
# @return [Types::PutBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1000
|
+
#
|
1001
|
+
# * {Types::PutBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
|
1002
|
+
#
|
1003
|
+
# @example Request syntax with placeholder values
|
1004
|
+
#
|
1005
|
+
# resp = client.put_bandwidth_rate_limit_schedule({
|
1006
|
+
# bandwidth_rate_limit_intervals: [ # required
|
1007
|
+
# {
|
1008
|
+
# average_upload_rate_limit_in_bits_per_sec: 1,
|
1009
|
+
# days_of_week: [1], # required
|
1010
|
+
# end_hour_of_day: 1, # required
|
1011
|
+
# end_minute_of_hour: 1, # required
|
1012
|
+
# start_hour_of_day: 1, # required
|
1013
|
+
# start_minute_of_hour: 1, # required
|
1014
|
+
# },
|
1015
|
+
# ],
|
1016
|
+
# gateway_arn: "GatewayArn", # required
|
1017
|
+
# })
|
1018
|
+
#
|
1019
|
+
# @example Response structure
|
1020
|
+
#
|
1021
|
+
# resp.gateway_arn #=> String
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule AWS API Documentation
|
1024
|
+
#
|
1025
|
+
# @overload put_bandwidth_rate_limit_schedule(params = {})
|
1026
|
+
# @param [Hash] params ({})
|
1027
|
+
def put_bandwidth_rate_limit_schedule(params = {}, options = {})
|
1028
|
+
req = build_request(:put_bandwidth_rate_limit_schedule, params)
|
1029
|
+
req.send_request(options)
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# This action sets the property mappings for the specified hypervisor. A
|
1033
|
+
# hypervisor property mapping displays the relationship of entity
|
1034
|
+
# properties available from the on-premises hypervisor to the properties
|
1035
|
+
# available in Amazon Web Services.
|
1036
|
+
#
|
1037
|
+
# @option params [required, String] :hypervisor_arn
|
1038
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1039
|
+
#
|
1040
|
+
# @option params [required, String] :iam_role_arn
|
1041
|
+
# The Amazon Resource Name (ARN) of the IAM role.
|
1042
|
+
#
|
1043
|
+
# @option params [required, Array<Types::VmwareToAwsTagMapping>] :vmware_to_aws_tag_mappings
|
1044
|
+
# This action requests the mappings of on-premises VMware tags to the
|
1045
|
+
# Amazon Web Services tags.
|
1046
|
+
#
|
1047
|
+
# @return [Types::PutHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1048
|
+
#
|
1049
|
+
# * {Types::PutHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
|
1050
|
+
#
|
1051
|
+
# @example Request syntax with placeholder values
|
1052
|
+
#
|
1053
|
+
# resp = client.put_hypervisor_property_mappings({
|
1054
|
+
# hypervisor_arn: "ServerArn", # required
|
1055
|
+
# iam_role_arn: "IamRoleArn", # required
|
1056
|
+
# vmware_to_aws_tag_mappings: [ # required
|
1057
|
+
# {
|
1058
|
+
# aws_tag_key: "TagKey", # required
|
1059
|
+
# aws_tag_value: "TagValue", # required
|
1060
|
+
# vmware_category: "VmwareCategory", # required
|
1061
|
+
# vmware_tag_name: "VmwareTagName", # required
|
1062
|
+
# },
|
1063
|
+
# ],
|
1064
|
+
# })
|
1065
|
+
#
|
1066
|
+
# @example Response structure
|
1067
|
+
#
|
1068
|
+
# resp.hypervisor_arn #=> String
|
1069
|
+
#
|
1070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappings AWS API Documentation
|
1071
|
+
#
|
1072
|
+
# @overload put_hypervisor_property_mappings(params = {})
|
1073
|
+
# @param [Hash] params ({})
|
1074
|
+
def put_hypervisor_property_mappings(params = {}, options = {})
|
1075
|
+
req = build_request(:put_hypervisor_property_mappings, params)
|
1076
|
+
req.send_request(options)
|
1077
|
+
end
|
1078
|
+
|
852
1079
|
# Set the maintenance start time for a gateway.
|
853
1080
|
#
|
854
1081
|
# @option params [Integer] :day_of_month
|
@@ -896,6 +1123,35 @@ module Aws::BackupGateway
|
|
896
1123
|
req.send_request(options)
|
897
1124
|
end
|
898
1125
|
|
1126
|
+
# This action sends a request to sync metadata across the specified
|
1127
|
+
# virtual machines.
|
1128
|
+
#
|
1129
|
+
# @option params [required, String] :hypervisor_arn
|
1130
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1131
|
+
#
|
1132
|
+
# @return [Types::StartVirtualMachinesMetadataSyncOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1133
|
+
#
|
1134
|
+
# * {Types::StartVirtualMachinesMetadataSyncOutput#hypervisor_arn #hypervisor_arn} => String
|
1135
|
+
#
|
1136
|
+
# @example Request syntax with placeholder values
|
1137
|
+
#
|
1138
|
+
# resp = client.start_virtual_machines_metadata_sync({
|
1139
|
+
# hypervisor_arn: "ServerArn", # required
|
1140
|
+
# })
|
1141
|
+
#
|
1142
|
+
# @example Response structure
|
1143
|
+
#
|
1144
|
+
# resp.hypervisor_arn #=> String
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync AWS API Documentation
|
1147
|
+
#
|
1148
|
+
# @overload start_virtual_machines_metadata_sync(params = {})
|
1149
|
+
# @param [Hash] params ({})
|
1150
|
+
def start_virtual_machines_metadata_sync(params = {}, options = {})
|
1151
|
+
req = build_request(:start_virtual_machines_metadata_sync, params)
|
1152
|
+
req.send_request(options)
|
1153
|
+
end
|
1154
|
+
|
899
1155
|
# Tag the resource.
|
900
1156
|
#
|
901
1157
|
# @option params [required, String] :resource_arn
|
@@ -1082,6 +1338,10 @@ module Aws::BackupGateway
|
|
1082
1338
|
# @option params [required, String] :hypervisor_arn
|
1083
1339
|
# The Amazon Resource Name (ARN) of the hypervisor to update.
|
1084
1340
|
#
|
1341
|
+
# @option params [String] :log_group_arn
|
1342
|
+
# The Amazon Resource Name (ARN) of the group of gateways within the
|
1343
|
+
# requested log.
|
1344
|
+
#
|
1085
1345
|
# @option params [String] :name
|
1086
1346
|
# The updated name for the hypervisor
|
1087
1347
|
#
|
@@ -1100,6 +1360,7 @@ module Aws::BackupGateway
|
|
1100
1360
|
# resp = client.update_hypervisor({
|
1101
1361
|
# host: "Host",
|
1102
1362
|
# hypervisor_arn: "ServerArn", # required
|
1363
|
+
# log_group_arn: "LogGroupArn",
|
1103
1364
|
# name: "Name",
|
1104
1365
|
# password: "Password",
|
1105
1366
|
# username: "Username",
|
@@ -1131,7 +1392,7 @@ module Aws::BackupGateway
|
|
1131
1392
|
params: params,
|
1132
1393
|
config: config)
|
1133
1394
|
context[:gem_name] = 'aws-sdk-backupgateway'
|
1134
|
-
context[:gem_version] = '1.
|
1395
|
+
context[:gem_version] = '1.7.0'
|
1135
1396
|
Seahorse::Client::Request.new(handlers, context)
|
1136
1397
|
end
|
1137
1398
|
|