View Source AWS.BackupGateway (aws-elixir v1.0.0)
Backup gateway
Backup 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.
Summary
Functions
Associates a backup gateway with your server.
Creates a backup gateway.
Deletes a backup gateway.
Deletes a hypervisor.
Disassociates a backup gateway from the specified server.
Retrieves the bandwidth rate limit schedule for a specified gateway.
By providing the ARN (Amazon Resource Name), this API returns the gateway.
This action requests information about the specified hypervisor to which the gateway will connect.
This action retrieves the property mappings for the specified hypervisor.
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
Connect to a hypervisor by importing its configuration.
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
Lists your hypervisors.
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
Lists your virtual machines.
This action sets the bandwidth rate limit schedule for a specified gateway.
This action sets the property mappings for the specified hypervisor.
Set the maintenance start time for a gateway.
This action sends a request to sync metadata across the specified virtual machines.
Tag the resource.
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Removes tags from the resource.
Updates a gateway's name.
Updates the gateway virtual machine (VM) software.
Updates a hypervisor metadata, including its host, username, and password.
Functions
Associates a backup gateway with your server.
After you complete the association process, you can back up and restore your VMs through the gateway.
Creates a backup gateway.
After you create a gateway, you can associate it with a server
using the AssociateGatewayToServer operation.
Deletes a backup gateway.
Deletes a hypervisor.
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.
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.
By providing the ARN (Amazon Resource Name), this API returns the gateway.
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.
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.
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
Connect to a hypervisor by importing its configuration.
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).
Lists your hypervisors.
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
Lists your virtual machines.
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.
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.
Set the maintenance start time for a gateway.
start_virtual_machines_metadata_sync(client, input, options \\ [])
View SourceThis action sends a request to sync metadata across the specified virtual machines.
Tag the resource.
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Removes tags from the resource.
Updates a gateway's name.
Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
Updates the gateway virtual machine (VM) software.
The request immediately triggers the software update.
When you make this request, you get a 200 OK
success response immediately. However, it might take some
time for the update to complete.
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.