(constructor)

[configuration]

Constructs a new instance of the <code>BackupGatewayClient</code> class

config

The resolved configuration of BackupGatewayClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-backup-gateway!BackupGatewayClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

BackupGatewayClient

<fullname>Backup gateway</fullname> 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.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AssociateGatewayToServerCommand

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

CreateGatewayCommand

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

DeleteGatewayCommand

DeleteHypervisorCommand

DisassociateGatewayFromServerCommand

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.

GetBandwidthRateLimitScheduleCommand

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.

GetGatewayCommand

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

GetHypervisorCommand

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.

GetHypervisorPropertyMappingsCommand

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.

GetVirtualMachineCommand

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

ImportHypervisorConfigurationCommand

Connect to a hypervisor by importing its configuration.

ListGatewaysCommand

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

ListHypervisorsCommand

ListTagsForResourceCommand

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

ListVirtualMachinesCommand

PutBandwidthRateLimitScheduleCommand

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.

PutHypervisorPropertyMappingsCommand

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.

PutMaintenanceStartTimeCommand

Set the maintenance start time for a gateway.

StartVirtualMachinesMetadataSyncCommand

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

TagResourceCommand

TestHypervisorConfigurationCommand

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

UntagResourceCommand

UpdateGatewayInformationCommand

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

UpdateGatewaySoftwareNowCommand

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note> When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. </note>

UpdateHypervisorCommand

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.