hypervisors

Creates, updates, deletes, gets or lists a hypervisors resource.

Overview

Name	hypervisors
Type	Resource
Id	aws.backup_gateway.hypervisors

Fields

The following fields are returned by SELECT queries:

get_hypervisor

Name	Datatype	Description
host	string	The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). (pattern: <code>.+</code>)
hypervisor_arn	string	The Amazon Resource Name (ARN) of the hypervisor. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)
kms_key_arn	string	The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor. (pattern: <code>(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)</code>)
last_successful_metadata_sync_time	string (date-time)	This is the time when the most recent successful sync of metadata occurred.
latest_metadata_sync_status	string	This is the most recent status for the indicated metadata sync. (CREATED, RUNNING, FAILED, PARTIALLY_FAILED, SUCCEEDED)
latest_metadata_sync_status_message	string	This is the most recent status for the indicated metadata sync.
log_group_arn	string	The Amazon Resource Name (ARN) of the group of gateways within the requested log. (pattern: <code>$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_-/.]+:*</code>)
name	string	This is the name of the specified hypervisor. (pattern: <code>[a-zA-Z0-9-]*</code>)
state	string	This is the current state of the specified hypervisor. The possible states are PENDING, ONLINE, OFFLINE, or ERROR. (PENDING, ONLINE, OFFLINE, ERROR)

list_hypervisors

Name	Datatype	Description
host	string	The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). (pattern: <code>.+</code>)
hypervisor_arn	string	The Amazon Resource Name (ARN) of the hypervisor. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)
kms_key_arn	string	The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor. (pattern: <code>(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)</code>)
name	string	The name of the hypervisor. (pattern: <code>[a-zA-Z0-9-]*</code>)
state	string	The state of the hypervisor. (PENDING, ONLINE, OFFLINE, ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_hypervisor	select	region		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.
list_hypervisors	select	region		Lists your hypervisors.
update_hypervisor	update	region, HypervisorArn		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.
delete_hypervisor	delete	region		Deletes a hypervisor.
import_hypervisor_configuration	exec	region		Connect to a hypervisor by importing its configuration.
test_hypervisor_configuration	exec	region, GatewayArn		Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_hypervisor

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.

SELECT
host,
hypervisor_arn,
kms_key_arn,
last_successful_metadata_sync_time,
latest_metadata_sync_status,
latest_metadata_sync_status_message,
log_group_arn,
name,
state
FROM aws.backup_gateway.hypervisors
WHERE region = '{{ region }}' -- required
;

list_hypervisors

Lists your hypervisors.

SELECT
host,
hypervisor_arn,
kms_key_arn,
name,
state
FROM aws.backup_gateway.hypervisors
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_hypervisor

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.

UPDATE aws.backup_gateway.hypervisors
SET 
HypervisorArn = '{{ HypervisorArn }}',
Host = '{{ Host }}',
Username = '{{ Username }}',
Password = '{{ Password }}',
Name = '{{ Name }}',
LogGroupArn = '{{ LogGroupArn }}'
WHERE 
region = '{{ region }}' --required
AND HypervisorArn = '{{ HypervisorArn }}' --required
RETURNING
hypervisor_arn;

DELETE examples

delete_hypervisor

Deletes a hypervisor.

DELETE FROM aws.backup_gateway.hypervisors
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

import_hypervisor_configuration

Connect to a hypervisor by importing its configuration.

EXEC aws.backup_gateway.hypervisors.import_hypervisor_configuration 
@region='{{ region }}' --required 
@@json=
'{
"Name": "{{ Name }}", 
"Host": "{{ Host }}", 
"Username": "{{ Username }}", 
"Password": "{{ Password }}", 
"KmsKeyArn": "{{ KmsKeyArn }}", 
"Tags": "{{ Tags }}"
}'
;

test_hypervisor_configuration

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

EXEC aws.backup_gateway.hypervisors.test_hypervisor_configuration 
@region='{{ region }}' --required 
@@json=
'{
"GatewayArn": "{{ GatewayArn }}", 
"Host": "{{ Host }}", 
"Username": "{{ Username }}", 
"Password": "{{ Password }}"
}'
;