backupgateway/aws.sdk.kotlin.services.backupgateway/BackupGatewayClient

BackupGatewayClient

interface BackupGatewayClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: BackupGatewayClient.Config

BackupGatewayClient's configuration

Functions

Link copied to clipboard
abstract suspend fun associateGatewayToServer(input: AssociateGatewayToServerRequest): AssociateGatewayToServerResponse

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 copied to clipboard
abstract suspend fun createGateway(input: CreateGatewayRequest): CreateGatewayResponse

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

Link copied to clipboard
abstract suspend fun deleteGateway(input: DeleteGatewayRequest): DeleteGatewayResponse

Deletes a backup gateway.

Link copied to clipboard
abstract suspend fun deleteHypervisor(input: DeleteHypervisorRequest): DeleteHypervisorResponse

Deletes a hypervisor.

Link copied to clipboard
abstract suspend fun disassociateGatewayFromServer(input: DisassociateGatewayFromServerRequest): DisassociateGatewayFromServerResponse

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 copied to clipboard
abstract suspend fun getBandwidthRateLimitSchedule(input: GetBandwidthRateLimitScheduleRequest): GetBandwidthRateLimitScheduleResponse

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 copied to clipboard
abstract suspend fun getGateway(input: GetGatewayRequest): GetGatewayResponse

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

Link copied to clipboard
abstract suspend fun getHypervisor(input: GetHypervisorRequest): GetHypervisorResponse

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 copied to clipboard
abstract suspend fun getHypervisorPropertyMappings(input: GetHypervisorPropertyMappingsRequest): GetHypervisorPropertyMappingsResponse

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 copied to clipboard
abstract suspend fun getVirtualMachine(input: GetVirtualMachineRequest): GetVirtualMachineResponse

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

Link copied to clipboard
abstract suspend fun importHypervisorConfiguration(input: ImportHypervisorConfigurationRequest): ImportHypervisorConfigurationResponse

Connect to a hypervisor by importing its configuration.

Link copied to clipboard
abstract suspend fun listGateways(input: ListGatewaysRequest = ListGatewaysRequest { }): ListGatewaysResponse

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 copied to clipboard
abstract suspend fun listHypervisors(input: ListHypervisorsRequest = ListHypervisorsRequest { }): ListHypervisorsResponse

Lists your hypervisors.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

Link copied to clipboard
abstract suspend fun listVirtualMachines(input: ListVirtualMachinesRequest = ListVirtualMachinesRequest { }): ListVirtualMachinesResponse

Lists your virtual machines.

Link copied to clipboard
abstract suspend fun putBandwidthRateLimitSchedule(input: PutBandwidthRateLimitScheduleRequest): PutBandwidthRateLimitScheduleResponse

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 copied to clipboard
abstract suspend fun putHypervisorPropertyMappings(input: PutHypervisorPropertyMappingsRequest): PutHypervisorPropertyMappingsResponse

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 copied to clipboard
abstract suspend fun putMaintenanceStartTime(input: PutMaintenanceStartTimeRequest): PutMaintenanceStartTimeResponse

Set the maintenance start time for a gateway.

Link copied to clipboard
abstract suspend fun startVirtualMachinesMetadataSync(input: StartVirtualMachinesMetadataSyncRequest): StartVirtualMachinesMetadataSyncResponse

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tag the resource.

Link copied to clipboard
abstract suspend fun testHypervisorConfiguration(input: TestHypervisorConfigurationRequest): TestHypervisorConfigurationResponse

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

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the resource.

Link copied to clipboard
abstract suspend fun updateGatewayInformation(input: UpdateGatewayInformationRequest): UpdateGatewayInformationResponse

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

Link copied to clipboard
abstract suspend fun updateGatewaySoftwareNow(input: UpdateGatewaySoftwareNowRequest): UpdateGatewaySoftwareNowResponse

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

Link copied to clipboard
abstract suspend fun updateHypervisor(input: UpdateHypervisorRequest): UpdateHypervisorResponse

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.

Inherited functions

Link copied to clipboard
inline suspend fun BackupGatewayClient.associateGatewayToServer(crossinline block: AssociateGatewayToServerRequest.Builder.() -> Unit): AssociateGatewayToServerResponse

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 copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun BackupGatewayClient.createGateway(crossinline block: CreateGatewayRequest.Builder.() -> Unit): CreateGatewayResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.deleteGateway(crossinline block: DeleteGatewayRequest.Builder.() -> Unit): DeleteGatewayResponse

Deletes a backup gateway.

Link copied to clipboard
inline suspend fun BackupGatewayClient.deleteHypervisor(crossinline block: DeleteHypervisorRequest.Builder.() -> Unit): DeleteHypervisorResponse

Deletes a hypervisor.

Link copied to clipboard
inline suspend fun BackupGatewayClient.disassociateGatewayFromServer(crossinline block: DisassociateGatewayFromServerRequest.Builder.() -> Unit): DisassociateGatewayFromServerResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.getBandwidthRateLimitSchedule(crossinline block: GetBandwidthRateLimitScheduleRequest.Builder.() -> Unit): GetBandwidthRateLimitScheduleResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.getGateway(crossinline block: GetGatewayRequest.Builder.() -> Unit): GetGatewayResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.getHypervisor(crossinline block: GetHypervisorRequest.Builder.() -> Unit): GetHypervisorResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.getHypervisorPropertyMappings(crossinline block: GetHypervisorPropertyMappingsRequest.Builder.() -> Unit): GetHypervisorPropertyMappingsResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.getVirtualMachine(crossinline block: GetVirtualMachineRequest.Builder.() -> Unit): GetVirtualMachineResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.importHypervisorConfiguration(crossinline block: ImportHypervisorConfigurationRequest.Builder.() -> Unit): ImportHypervisorConfigurationResponse

Connect to a hypervisor by importing its configuration.

Link copied to clipboard
inline suspend fun BackupGatewayClient.listGateways(crossinline block: ListGatewaysRequest.Builder.() -> Unit): ListGatewaysResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.listHypervisors(crossinline block: ListHypervisorsRequest.Builder.() -> Unit): ListHypervisorsResponse

Lists your hypervisors.

Link copied to clipboard
inline suspend fun BackupGatewayClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.listVirtualMachines(crossinline block: ListVirtualMachinesRequest.Builder.() -> Unit): ListVirtualMachinesResponse

Lists your virtual machines.

Link copied to clipboard
inline suspend fun BackupGatewayClient.putBandwidthRateLimitSchedule(crossinline block: PutBandwidthRateLimitScheduleRequest.Builder.() -> Unit): PutBandwidthRateLimitScheduleResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.putHypervisorPropertyMappings(crossinline block: PutHypervisorPropertyMappingsRequest.Builder.() -> Unit): PutHypervisorPropertyMappingsResponse

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 copied to clipboard
inline suspend fun BackupGatewayClient.putMaintenanceStartTime(crossinline block: PutMaintenanceStartTimeRequest.Builder.() -> Unit): PutMaintenanceStartTimeResponse

Set the maintenance start time for a gateway.

Link copied to clipboard
inline suspend fun BackupGatewayClient.startVirtualMachinesMetadataSync(crossinline block: StartVirtualMachinesMetadataSyncRequest.Builder.() -> Unit): StartVirtualMachinesMetadataSyncResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tag the resource.

Link copied to clipboard
inline suspend fun BackupGatewayClient.testHypervisorConfiguration(crossinline block: TestHypervisorConfigurationRequest.Builder.() -> Unit): TestHypervisorConfigurationResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the resource.

Link copied to clipboard
inline suspend fun BackupGatewayClient.updateGatewayInformation(crossinline block: UpdateGatewayInformationRequest.Builder.() -> Unit): UpdateGatewayInformationResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.updateGatewaySoftwareNow(crossinline block: UpdateGatewaySoftwareNowRequest.Builder.() -> Unit): UpdateGatewaySoftwareNowResponse

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

Link copied to clipboard
inline suspend fun BackupGatewayClient.updateHypervisor(crossinline block: UpdateHypervisorRequest.Builder.() -> Unit): UpdateHypervisorResponse

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.

Link copied to clipboard
fun BackupGatewayClient.withConfig(block: BackupGatewayClient.Config.Builder.() -> Unit): BackupGatewayClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.