@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBackupGatewayAsync extends AWSBackupGateway
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBackupGatewayAsync instead.
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.
ENDPOINT_PREFIXassociateGatewayToServer, createGateway, deleteGateway, deleteHypervisor, disassociateGatewayFromServer, getBandwidthRateLimitSchedule, getCachedResponseMetadata, getGateway, getHypervisor, getHypervisorPropertyMappings, getVirtualMachine, importHypervisorConfiguration, listGateways, listHypervisors, listTagsForResource, listVirtualMachines, putBandwidthRateLimitSchedule, putHypervisorPropertyMappings, putMaintenanceStartTime, shutdown, startVirtualMachinesMetadataSync, tagResource, testHypervisorConfiguration, untagResource, updateGatewayInformation, updateGatewaySoftwareNow, updateHypervisorFuture<AssociateGatewayToServerResult> associateGatewayToServerAsync(AssociateGatewayToServerRequest associateGatewayToServerRequest)
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
associateGatewayToServerRequest - Future<AssociateGatewayToServerResult> associateGatewayToServerAsync(AssociateGatewayToServerRequest associateGatewayToServerRequest, AsyncHandler<AssociateGatewayToServerRequest,AssociateGatewayToServerResult> asyncHandler)
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
associateGatewayToServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGatewayResult> createGatewayAsync(CreateGatewayRequest createGatewayRequest)
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
createGatewayRequest - Future<CreateGatewayResult> createGatewayAsync(CreateGatewayRequest createGatewayRequest, AsyncHandler<CreateGatewayRequest,CreateGatewayResult> asyncHandler)
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
createGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest)
Deletes a backup gateway.
deleteGatewayRequest - Future<DeleteGatewayResult> deleteGatewayAsync(DeleteGatewayRequest deleteGatewayRequest, AsyncHandler<DeleteGatewayRequest,DeleteGatewayResult> asyncHandler)
Deletes a backup gateway.
deleteGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteHypervisorResult> deleteHypervisorAsync(DeleteHypervisorRequest deleteHypervisorRequest)
Deletes a hypervisor.
deleteHypervisorRequest - Future<DeleteHypervisorResult> deleteHypervisorAsync(DeleteHypervisorRequest deleteHypervisorRequest, AsyncHandler<DeleteHypervisorRequest,DeleteHypervisorResult> asyncHandler)
Deletes a hypervisor.
deleteHypervisorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateGatewayFromServerResult> disassociateGatewayFromServerAsync(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)
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.
disassociateGatewayFromServerRequest - Future<DisassociateGatewayFromServerResult> disassociateGatewayFromServerAsync(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest, AsyncHandler<DisassociateGatewayFromServerRequest,DisassociateGatewayFromServerResult> asyncHandler)
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.
disassociateGatewayFromServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBandwidthRateLimitScheduleResult> getBandwidthRateLimitScheduleAsync(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)
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.
getBandwidthRateLimitScheduleRequest - Future<GetBandwidthRateLimitScheduleResult> getBandwidthRateLimitScheduleAsync(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest, AsyncHandler<GetBandwidthRateLimitScheduleRequest,GetBandwidthRateLimitScheduleResult> asyncHandler)
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.
getBandwidthRateLimitScheduleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGatewayResult> getGatewayAsync(GetGatewayRequest getGatewayRequest)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
getGatewayRequest - Future<GetGatewayResult> getGatewayAsync(GetGatewayRequest getGatewayRequest, AsyncHandler<GetGatewayRequest,GetGatewayResult> asyncHandler)
By providing the ARN (Amazon Resource Name), this API returns the gateway.
getGatewayRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetHypervisorResult> getHypervisorAsync(GetHypervisorRequest getHypervisorRequest)
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.
getHypervisorRequest - Future<GetHypervisorResult> getHypervisorAsync(GetHypervisorRequest getHypervisorRequest, AsyncHandler<GetHypervisorRequest,GetHypervisorResult> asyncHandler)
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.
getHypervisorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetHypervisorPropertyMappingsResult> getHypervisorPropertyMappingsAsync(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)
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.
getHypervisorPropertyMappingsRequest - Future<GetHypervisorPropertyMappingsResult> getHypervisorPropertyMappingsAsync(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest, AsyncHandler<GetHypervisorPropertyMappingsRequest,GetHypervisorPropertyMappingsResult> asyncHandler)
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.
getHypervisorPropertyMappingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetVirtualMachineResult> getVirtualMachineAsync(GetVirtualMachineRequest getVirtualMachineRequest)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
getVirtualMachineRequest - Future<GetVirtualMachineResult> getVirtualMachineAsync(GetVirtualMachineRequest getVirtualMachineRequest, AsyncHandler<GetVirtualMachineRequest,GetVirtualMachineResult> asyncHandler)
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
getVirtualMachineRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportHypervisorConfigurationResult> importHypervisorConfigurationAsync(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
importHypervisorConfigurationRequest - Future<ImportHypervisorConfigurationResult> importHypervisorConfigurationAsync(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest, AsyncHandler<ImportHypervisorConfigurationRequest,ImportHypervisorConfigurationResult> asyncHandler)
Connect to a hypervisor by importing its configuration.
importHypervisorConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest listGatewaysRequest)
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).
listGatewaysRequest - Future<ListGatewaysResult> listGatewaysAsync(ListGatewaysRequest listGatewaysRequest, AsyncHandler<ListGatewaysRequest,ListGatewaysResult> asyncHandler)
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).
listGatewaysRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListHypervisorsResult> listHypervisorsAsync(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
listHypervisorsRequest - Future<ListHypervisorsResult> listHypervisorsAsync(ListHypervisorsRequest listHypervisorsRequest, AsyncHandler<ListHypervisorsRequest,ListHypervisorsResult> asyncHandler)
Lists your hypervisors.
listHypervisorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVirtualMachinesResult> listVirtualMachinesAsync(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
listVirtualMachinesRequest - Future<ListVirtualMachinesResult> listVirtualMachinesAsync(ListVirtualMachinesRequest listVirtualMachinesRequest, AsyncHandler<ListVirtualMachinesRequest,ListVirtualMachinesResult> asyncHandler)
Lists your virtual machines.
listVirtualMachinesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBandwidthRateLimitScheduleResult> putBandwidthRateLimitScheduleAsync(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)
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.
putBandwidthRateLimitScheduleRequest - Future<PutBandwidthRateLimitScheduleResult> putBandwidthRateLimitScheduleAsync(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest, AsyncHandler<PutBandwidthRateLimitScheduleRequest,PutBandwidthRateLimitScheduleResult> asyncHandler)
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.
putBandwidthRateLimitScheduleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutHypervisorPropertyMappingsResult> putHypervisorPropertyMappingsAsync(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)
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.
putHypervisorPropertyMappingsRequest - Future<PutHypervisorPropertyMappingsResult> putHypervisorPropertyMappingsAsync(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest, AsyncHandler<PutHypervisorPropertyMappingsRequest,PutHypervisorPropertyMappingsResult> asyncHandler)
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.
putHypervisorPropertyMappingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMaintenanceStartTimeResult> putMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
putMaintenanceStartTimeRequest - Future<PutMaintenanceStartTimeResult> putMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest, AsyncHandler<PutMaintenanceStartTimeRequest,PutMaintenanceStartTimeResult> asyncHandler)
Set the maintenance start time for a gateway.
putMaintenanceStartTimeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartVirtualMachinesMetadataSyncResult> startVirtualMachinesMetadataSyncAsync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)
This action sends a request to sync metadata across the specified virtual machines.
startVirtualMachinesMetadataSyncRequest - Future<StartVirtualMachinesMetadataSyncResult> startVirtualMachinesMetadataSyncAsync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest, AsyncHandler<StartVirtualMachinesMetadataSyncRequest,StartVirtualMachinesMetadataSyncResult> asyncHandler)
This action sends a request to sync metadata across the specified virtual machines.
startVirtualMachinesMetadataSyncRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Tag the resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tag the resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TestHypervisorConfigurationResult> testHypervisorConfigurationAsync(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
testHypervisorConfigurationRequest - Future<TestHypervisorConfigurationResult> testHypervisorConfigurationAsync(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest, AsyncHandler<TestHypervisorConfigurationRequest,TestHypervisorConfigurationResult> asyncHandler)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
testHypervisorConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from the resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from the resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
updateGatewayInformationRequest - Future<UpdateGatewayInformationResult> updateGatewayInformationAsync(UpdateGatewayInformationRequest updateGatewayInformationRequest, AsyncHandler<UpdateGatewayInformationRequest,UpdateGatewayInformationResult> asyncHandler)
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
updateGatewayInformationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take
some time for the update to complete.
updateGatewaySoftwareNowRequest - Future<UpdateGatewaySoftwareNowResult> updateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest, AsyncHandler<UpdateGatewaySoftwareNowRequest,UpdateGatewaySoftwareNowResult> asyncHandler)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take
some time for the update to complete.
updateGatewaySoftwareNowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateHypervisorResult> updateHypervisorAsync(UpdateHypervisorRequest updateHypervisorRequest)
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.
updateHypervisorRequest - Future<UpdateHypervisorResult> updateHypervisorAsync(UpdateHypervisorRequest updateHypervisorRequest, AsyncHandler<UpdateHypervisorRequest,UpdateHypervisorResult> asyncHandler)
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.
updateHypervisorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.