Implementation for accessing BackupGateway
Backup gatewayBackup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.
Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.
Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.
To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.
Inheritance Hierarchy
Namespace: Amazon.BackupGateway
Assembly: AWSSDK.BackupGateway.dll
Version: 3.x.y.z
Syntax
public class AmazonBackupGatewayClient : AmazonServiceClient IAmazonBackupGateway, IAmazonService, IDisposable
The AmazonBackupGatewayClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonBackupGatewayClient() |
Constructs AmazonBackupGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBackupGatewayClient(RegionEndpoint) |
Constructs AmazonBackupGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBackupGatewayClient(AmazonBackupGatewayConfig) |
Constructs AmazonBackupGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBackupGatewayClient(AWSCredentials) |
Constructs AmazonBackupGatewayClient with AWS Credentials |
|
|
AmazonBackupGatewayClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonBackupGatewayClient with AWS Credentials |
|
|
AmazonBackupGatewayClient(AWSCredentials, AmazonBackupGatewayConfig) |
Constructs AmazonBackupGatewayClient with AWS Credentials and an AmazonBackupGatewayClient Configuration object. |
|
|
AmazonBackupGatewayClient(string, string) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBackupGatewayClient(string, string, RegionEndpoint) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBackupGatewayClient(string, string, AmazonBackupGatewayConfig) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupGatewayClient Configuration object. |
|
|
AmazonBackupGatewayClient(string, string, string) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBackupGatewayClient(string, string, string, RegionEndpoint) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBackupGatewayClient(string, string, string, AmazonBackupGatewayConfig) |
Constructs AmazonBackupGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupGatewayClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.BackupGateway.Model.IBackupGatewayPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
AssociateGatewayToServer(AssociateGatewayToServerRequest) |
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway. |
|
|
AssociateGatewayToServerAsync(AssociateGatewayToServerRequest, CancellationToken) |
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway. |
|
|
CreateGateway(CreateGatewayRequest) |
Creates a backup gateway. After you create a gateway, you can associate it with a
server using the |
|
|
CreateGatewayAsync(CreateGatewayRequest, CancellationToken) |
Creates a backup gateway. After you create a gateway, you can associate it with a
server using the |
|
|
DeleteGateway(DeleteGatewayRequest) |
Deletes a backup gateway. |
|
|
DeleteGatewayAsync(DeleteGatewayRequest, CancellationToken) |
Deletes a backup gateway. |
|
|
DeleteHypervisor(DeleteHypervisorRequest) |
Deletes a hypervisor. |
|
|
DeleteHypervisorAsync(DeleteHypervisorRequest, CancellationToken) |
Deletes a hypervisor. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
DisassociateGatewayFromServer(DisassociateGatewayFromServerRequest) |
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server. |
|
|
DisassociateGatewayFromServerAsync(DisassociateGatewayFromServerRequest, CancellationToken) |
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest) |
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule. |
|
|
GetBandwidthRateLimitScheduleAsync(GetBandwidthRateLimitScheduleRequest, CancellationToken) |
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule. |
|
|
GetGateway(GetGatewayRequest) |
By providing the ARN (Amazon Resource Name), this API returns the gateway. |
|
|
GetGatewayAsync(GetGatewayRequest, CancellationToken) |
By providing the ARN (Amazon Resource Name), this API returns the gateway. |
|
|
GetHypervisor(GetHypervisorRequest) |
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them. |
|
|
GetHypervisorAsync(GetHypervisorRequest, CancellationToken) |
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them. |
|
|
GetHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest) |
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. |
|
|
GetHypervisorPropertyMappingsAsync(GetHypervisorPropertyMappingsRequest, CancellationToken) |
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. |
|
|
GetVirtualMachine(GetVirtualMachineRequest) |
By providing the ARN (Amazon Resource Name), this API returns the virtual machine. |
|
|
GetVirtualMachineAsync(GetVirtualMachineRequest, CancellationToken) |
By providing the ARN (Amazon Resource Name), this API returns the virtual machine. |
|
|
ImportHypervisorConfiguration(ImportHypervisorConfigurationRequest) |
Connect to a hypervisor by importing its configuration. |
|
|
ImportHypervisorConfigurationAsync(ImportHypervisorConfigurationRequest, CancellationToken) |
Connect to a hypervisor by importing its configuration. |
|
|
ListGateways(ListGatewaysRequest) |
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN). |
|
|
ListGatewaysAsync(ListGatewaysRequest, CancellationToken) |
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN). |
|
|
ListHypervisors(ListHypervisorsRequest) |
Lists your hypervisors. |
|
|
ListHypervisorsAsync(ListHypervisorsRequest, CancellationToken) |
Lists your hypervisors. |
|
|
ListTagsForResource(ListTagsForResourceRequest) |
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). |
|
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). |
|
|
ListVirtualMachines(ListVirtualMachinesRequest) |
Lists your virtual machines. |
|
|
ListVirtualMachinesAsync(ListVirtualMachinesRequest, CancellationToken) |
Lists your virtual machines. |
|
|
PutBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest) |
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule. |
|
|
PutBandwidthRateLimitScheduleAsync(PutBandwidthRateLimitScheduleRequest, CancellationToken) |
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule. |
|
|
PutHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest) |
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. |
|
|
PutHypervisorPropertyMappingsAsync(PutHypervisorPropertyMappingsRequest, CancellationToken) |
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. |
|
|
PutMaintenanceStartTime(PutMaintenanceStartTimeRequest) |
Set the maintenance start time for a gateway. |
|
|
PutMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest, CancellationToken) |
Set the maintenance start time for a gateway. |
|
|
StartVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest) |
This action sends a request to sync metadata across the specified virtual machines. |
|
|
StartVirtualMachinesMetadataSyncAsync(StartVirtualMachinesMetadataSyncRequest, CancellationToken) |
This action sends a request to sync metadata across the specified virtual machines. |
|
|
TagResource(TagResourceRequest) |
Tag the resource. |
|
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Tag the resource. |
|
|
TestHypervisorConfiguration(TestHypervisorConfigurationRequest) |
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. |
|
|
TestHypervisorConfigurationAsync(TestHypervisorConfigurationRequest, CancellationToken) |
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. |
|
|
UntagResource(UntagResourceRequest) |
Removes tags from the resource. |
|
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes tags from the resource. |
|
|
UpdateGatewayInformation(UpdateGatewayInformationRequest) |
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. |
|
|
UpdateGatewayInformationAsync(UpdateGatewayInformationRequest, CancellationToken) |
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. |
|
|
UpdateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest) |
Updates the gateway virtual machine (VM) software. The request immediately triggers
the software update.
When you make this request, you get a |
|
|
UpdateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest, CancellationToken) |
Updates the gateway virtual machine (VM) software. The request immediately triggers
the software update.
When you make this request, you get a |
|
|
UpdateHypervisor(UpdateHypervisorRequest) |
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request. |
|
|
UpdateHypervisorAsync(UpdateHypervisorRequest, CancellationToken) |
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5