AWS.BackupGateway — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using BackupGateway

var backupgateway = new AWS.BackupGateway();
backupgateway.associateGatewayToServer(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the BackupGateway object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var backupgateway = new AWS.BackupGateway({apiVersion: '2021-01-01'});

You can also set the API version globally in AWS.config.apiVersions using the backupgateway service identifier:

AWS.config.apiVersions = {
  backupgateway: '2021-01-01',
  // other service API versions
};

var backupgateway = new AWS.BackupGateway();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.BackupGateway(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateGatewayToServer(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

deleteGateway(params = {}, callback) ⇒ AWS.Request

Deletes a backup gateway.

deleteHypervisor(params = {}, callback) ⇒ AWS.Request

disassociateGatewayFromServer(params = {}, callback) ⇒ AWS.Request

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.

getBandwidthRateLimitSchedule(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

getHypervisor(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

importHypervisorConfiguration(params = {}, callback) ⇒ AWS.Request

Connect to a hypervisor by importing its configuration.

listGateways(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

listVirtualMachines(params = {}, callback) ⇒ AWS.Request

Lists your virtual machines.

putBandwidthRateLimitSchedule(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Set the maintenance start time for a gateway.

startVirtualMachinesMetadataSync(params = {}, callback) ⇒ AWS.Request

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

testHypervisorConfiguration(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the resource.

updateGatewayInformation(params = {}, callback) ⇒ AWS.Request

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

updateGatewaySoftwareNow(params = {}, callback) ⇒ AWS.Request

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

Note: When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

updateHypervisor(params = {}, callback) ⇒ AWS.Request

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.