- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
BackupGatewayClient
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.
Installation
npm install @aws-sdk/client-backup-gateway
yarn add @aws-sdk/client-backup-gateway
pnpm add @aws-sdk/client-backup-gateway
BackupGatewayClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
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 |
DeleteGatewayCommand | Deletes a backup gateway. |
DeleteHypervisorCommand | Deletes a hypervisor. |
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 | Lists your hypervisors. |
ListTagsForResourceCommand | Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). |
ListVirtualMachinesCommand | Lists your virtual machines. |
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 | Tag the resource. |
TestHypervisorConfigurationCommand | Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. |
UntagResourceCommand | Removes tags from the resource. |
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. When you make this request, you get a |
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. |
BackupGatewayClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: BackupGatewayClientConfig