BackupGateway

import { BackupGateway } from "https://aws-api.deno.dev/v0.4/services/backupgateway.ts?docs=full";

class BackupGateway {

constructor(apiFactory: client.ApiFactory);

async associateGatewayToServer(params: AssociateGatewayToServerInput, opts?: client.RequestOptions): Promise<AssociateGatewayToServerOutput>;

async createGateway(params: CreateGatewayInput, opts?: client.RequestOptions): Promise<CreateGatewayOutput>;

async deleteGateway(params: DeleteGatewayInput, opts?: client.RequestOptions): Promise<DeleteGatewayOutput>;

async deleteHypervisor(params: DeleteHypervisorInput, opts?: client.RequestOptions): Promise<DeleteHypervisorOutput>;

async disassociateGatewayFromServer(params: DisassociateGatewayFromServerInput, opts?: client.RequestOptions): Promise<DisassociateGatewayFromServerOutput>;

async getBandwidthRateLimitSchedule(params: GetBandwidthRateLimitScheduleInput, opts?: client.RequestOptions): Promise<GetBandwidthRateLimitScheduleOutput>;

async getGateway(params: GetGatewayInput, opts?: client.RequestOptions): Promise<GetGatewayOutput>;

async getHypervisor(params: GetHypervisorInput, opts?: client.RequestOptions): Promise<GetHypervisorOutput>;

async getHypervisorPropertyMappings(params: GetHypervisorPropertyMappingsInput, opts?: client.RequestOptions): Promise<GetHypervisorPropertyMappingsOutput>;

async getVirtualMachine(params: GetVirtualMachineInput, opts?: client.RequestOptions): Promise<GetVirtualMachineOutput>;

async importHypervisorConfiguration(params: ImportHypervisorConfigurationInput, opts?: client.RequestOptions): Promise<ImportHypervisorConfigurationOutput>;

async listGateways(params?: ListGatewaysInput, opts?: client.RequestOptions): Promise<ListGatewaysOutput>;

async listHypervisors(params?: ListHypervisorsInput, opts?: client.RequestOptions): Promise<ListHypervisorsOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async listVirtualMachines(params?: ListVirtualMachinesInput, opts?: client.RequestOptions): Promise<ListVirtualMachinesOutput>;

async putBandwidthRateLimitSchedule(params: PutBandwidthRateLimitScheduleInput, opts?: client.RequestOptions): Promise<PutBandwidthRateLimitScheduleOutput>;

async putHypervisorPropertyMappings(params: PutHypervisorPropertyMappingsInput, opts?: client.RequestOptions): Promise<PutHypervisorPropertyMappingsOutput>;

async putMaintenanceStartTime(params: PutMaintenanceStartTimeInput, opts?: client.RequestOptions): Promise<PutMaintenanceStartTimeOutput>;

async startVirtualMachinesMetadataSync(params: StartVirtualMachinesMetadataSyncInput, opts?: client.RequestOptions): Promise<StartVirtualMachinesMetadataSyncOutput>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<TagResourceOutput>;

async testHypervisorConfiguration(params: TestHypervisorConfigurationInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<UntagResourceOutput>;

async updateGatewayInformation(params: UpdateGatewayInformationInput, opts?: client.RequestOptions): Promise<UpdateGatewayInformationOutput>;

async updateGatewaySoftwareNow(params: UpdateGatewaySoftwareNowInput, opts?: client.RequestOptions): Promise<UpdateGatewaySoftwareNowOutput>;

async updateHypervisor(params: UpdateHypervisorInput, opts?: client.RequestOptions): Promise<UpdateHypervisorOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new BackupGateway(apiFactory: client.ApiFactory)

[src]

§Methods

associateGatewayToServer(params: AssociateGatewayToServerInput, opts?: client.RequestOptions): Promise<AssociateGatewayToServerOutput>

[src]

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: CreateGatewayInput, opts?: client.RequestOptions): Promise<CreateGatewayOutput>

[src]

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

deleteGateway(params: DeleteGatewayInput, opts?: client.RequestOptions): Promise<DeleteGatewayOutput>

[src]

Deletes a backup gateway.

deleteHypervisor(params: DeleteHypervisorInput, opts?: client.RequestOptions): Promise<DeleteHypervisorOutput>

[src]

Deletes a hypervisor.

disassociateGatewayFromServer(params: DisassociateGatewayFromServerInput, opts?: client.RequestOptions): Promise<DisassociateGatewayFromServerOutput>

[src]

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: GetBandwidthRateLimitScheduleInput, opts?: client.RequestOptions): Promise<GetBandwidthRateLimitScheduleOutput>

[src]

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: GetGatewayInput, opts?: client.RequestOptions): Promise<GetGatewayOutput>

[src]

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

getHypervisor(params: GetHypervisorInput, opts?: client.RequestOptions): Promise<GetHypervisorOutput>

[src]

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: GetHypervisorPropertyMappingsInput, opts?: client.RequestOptions): Promise<GetHypervisorPropertyMappingsOutput>

[src]

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: GetVirtualMachineInput, opts?: client.RequestOptions): Promise<GetVirtualMachineOutput>

[src]

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

importHypervisorConfiguration(params: ImportHypervisorConfigurationInput, opts?: client.RequestOptions): Promise<ImportHypervisorConfigurationOutput>

[src]

Connect to a hypervisor by importing its configuration.

listGateways(params?: ListGatewaysInput, opts?: client.RequestOptions): Promise<ListGatewaysOutput>

[src]

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?: ListHypervisorsInput, opts?: client.RequestOptions): Promise<ListHypervisorsOutput>

[src]

Lists your hypervisors.

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

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

listVirtualMachines(params?: ListVirtualMachinesInput, opts?: client.RequestOptions): Promise<ListVirtualMachinesOutput>

[src]

Lists your virtual machines.

putBandwidthRateLimitSchedule(params: PutBandwidthRateLimitScheduleInput, opts?: client.RequestOptions): Promise<PutBandwidthRateLimitScheduleOutput>

[src]

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: PutHypervisorPropertyMappingsInput, opts?: client.RequestOptions): Promise<PutHypervisorPropertyMappingsOutput>

[src]

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: PutMaintenanceStartTimeInput, opts?: client.RequestOptions): Promise<PutMaintenanceStartTimeOutput>

[src]

Set the maintenance start time for a gateway.

startVirtualMachinesMetadataSync(params: StartVirtualMachinesMetadataSyncInput, opts?: client.RequestOptions): Promise<StartVirtualMachinesMetadataSyncOutput>

[src]

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

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<TagResourceOutput>

[src]

Tag the resource.

testHypervisorConfiguration(params: TestHypervisorConfigurationInput, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<UntagResourceOutput>

[src]

Removes tags from the resource.

updateGatewayInformation(params: UpdateGatewayInformationInput, opts?: client.RequestOptions): Promise<UpdateGatewayInformationOutput>

[src]

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

updateGatewaySoftwareNow(params: UpdateGatewaySoftwareNowInput, opts?: client.RequestOptions): Promise<UpdateGatewaySoftwareNowOutput>

[src]

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: UpdateHypervisorInput, opts?: client.RequestOptions): Promise<UpdateHypervisorOutput>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]