aws-elixir

View Source AWS.BackupGateway (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

associate_gateway_to_server(client, input, options \\ [])

Associates a backup gateway with your server.

create_gateway(client, input, options \\ [])

Creates a backup gateway.

delete_gateway(client, input, options \\ [])

Deletes a backup gateway.

delete_hypervisor(client, input, options \\ [])

Deletes a hypervisor.

disassociate_gateway_from_server(client, input, options \\ [])

Disassociates a backup gateway from the specified server.

get_bandwidth_rate_limit_schedule(client, input, options \\ [])

Retrieves the bandwidth rate limit schedule for a specified gateway.

get_gateway(client, input, options \\ [])

By providing the ARN (Amazon Resource Name), this API returns the gateway.

get_hypervisor(client, input, options \\ [])

This action requests information about the specified hypervisor to which the gateway will connect.

get_hypervisor_property_mappings(client, input, options \\ [])

This action retrieves the property mappings for the specified hypervisor.

get_virtual_machine(client, input, options \\ [])

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

import_hypervisor_configuration(client, input, options \\ [])

Connect to a hypervisor by importing its configuration.

list_gateways(client, input, options \\ [])

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.

list_hypervisors(client, input, options \\ [])

Lists your hypervisors.

list_tags_for_resource(client, input, options \\ [])

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

list_virtual_machines(client, input, options \\ [])

Lists your virtual machines.

metadata()
put_bandwidth_rate_limit_schedule(client, input, options \\ [])

This action sets the bandwidth rate limit schedule for a specified gateway.

put_hypervisor_property_mappings(client, input, options \\ [])

This action sets the property mappings for the specified hypervisor.

put_maintenance_start_time(client, input, options \\ [])

Set the maintenance start time for a gateway.

start_virtual_machines_metadata_sync(client, input, options \\ [])

This action sends a request to sync metadata across the specified virtual machines.

tag_resource(client, input, options \\ [])

Tag the resource.

test_hypervisor_configuration(client, input, options \\ [])

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

untag_resource(client, input, options \\ [])

Removes tags from the resource.

update_gateway_information(client, input, options \\ [])

Updates a gateway's name.

update_gateway_software_now(client, input, options \\ [])

Updates the gateway virtual machine (VM) software.

update_hypervisor(client, input, options \\ [])

Updates a hypervisor metadata, including its host, username, and password.

Link to this section Functions

Link to this function

associate_gateway_to_server(client, input, options \\ [])

View Source

Associates a backup gateway with your server.

After you complete the association process, you can back up and restore your VMs through the gateway.

Link to this function

create_gateway(client, input, options \\ [])

View Source

Creates a backup gateway.

After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Link to this function

delete_gateway(client, input, options \\ [])

View Source

Deletes a backup gateway.

Link to this function

delete_hypervisor(client, input, options \\ [])

View Source

Deletes a hypervisor.

Link to this function

disassociate_gateway_from_server(client, input, options \\ [])

View Source

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.

Link to this function

get_bandwidth_rate_limit_schedule(client, input, options \\ [])

View Source

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.

Link to this function

get_gateway(client, input, options \\ [])

View Source

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Link to this function

get_hypervisor(client, input, options \\ [])

View Source

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.

Link to this function

get_hypervisor_property_mappings(client, input, options \\ [])

View Source

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.

Link to this function

get_virtual_machine(client, input, options \\ [])

View Source

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Link to this function

import_hypervisor_configuration(client, input, options \\ [])

View Source

Connect to a hypervisor by importing its configuration.

Link to this function

list_gateways(client, input, options \\ [])

View Source

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).

Link to this function

list_hypervisors(client, input, options \\ [])

View Source

Lists your hypervisors.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Link to this function

list_virtual_machines(client, input, options \\ [])

View Source

Lists your virtual machines.

Link to this function

metadata()

View Source
Link to this function

put_bandwidth_rate_limit_schedule(client, input, options \\ [])

View Source

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.

Link to this function

put_hypervisor_property_mappings(client, input, options \\ [])

View Source

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.

Link to this function

put_maintenance_start_time(client, input, options \\ [])

View Source

Set the maintenance start time for a gateway.

Link to this function

start_virtual_machines_metadata_sync(client, input, options \\ [])

View Source

This action sends a request to sync metadata across the specified virtual machines.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Tag the resource.

Link to this function

test_hypervisor_configuration(client, input, options \\ [])

View Source

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from the resource.

Link to this function

update_gateway_information(client, input, options \\ [])

View Source

Updates a gateway's name.

Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Link to this function

update_gateway_software_now(client, input, options \\ [])

View Source

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.

Link to this function

update_hypervisor(client, input, options \\ [])

View Source

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.