hypervisors

Creates, updates, deletes or gets a hypervisor resource or lists hypervisors in a region

Overview

Name	hypervisors
Type	Resource
Description	Definition of AWS::BackupGateway::Hypervisor Resource Type
Id	aws.backupgateway.hypervisors

Fields

Name	Datatype	Description
host	string
hypervisor_arn	string
kms_key_arn	string
log_group_arn	string
name	string
password	string
tags	array
username	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all hypervisors in a region.

SELECT
region,
host,
hypervisor_arn,
kms_key_arn,
log_group_arn,
name,
password,
tags,
username
FROM aws.backupgateway.hypervisors
WHERE region = 'us-east-1';

Gets all properties from an individual hypervisor.

SELECT
region,
host,
hypervisor_arn,
kms_key_arn,
log_group_arn,
name,
password,
tags,
username
FROM aws.backupgateway.hypervisors
WHERE region = 'us-east-1' AND data__Identifier = '<HypervisorArn>';

INSERT example

Use the following StackQL query and manifest file to create a new hypervisor resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.backupgateway.hypervisors (
 Host,
 KmsKeyArn,
 LogGroupArn,
 Name,
 Password,
 Tags,
 Username,
 region
)
SELECT 
'{{ Host }}',
 '{{ KmsKeyArn }}',
 '{{ LogGroupArn }}',
 '{{ Name }}',
 '{{ Password }}',
 '{{ Tags }}',
 '{{ Username }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.backupgateway.hypervisors (
 Host,
 KmsKeyArn,
 LogGroupArn,
 Name,
 Password,
 Tags,
 Username,
 region
)
SELECT 
 '{{ Host }}',
 '{{ KmsKeyArn }}',
 '{{ LogGroupArn }}',
 '{{ Name }}',
 '{{ Password }}',
 '{{ Tags }}',
 '{{ Username }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: hypervisor
    props:
      - name: Host
        value: '{{ Host }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'
      - name: LogGroupArn
        value: '{{ LogGroupArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Password
        value: '{{ Password }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Username
        value: '{{ Username }}'

DELETE example

/*+ delete */
DELETE FROM aws.backupgateway.hypervisors
WHERE data__Identifier = '<HypervisorArn>'
AND region = 'us-east-1';

Permissions

To operate on the hypervisors resource, the following permissions are required:

Create

backup-gateway:ImportHypervisorConfiguration,
backup-gateway:GetHypervisor,
backup-gateway:ListHypervisors,
backup-gateway:TagResource,
kms:CreateGrant,
kms:Encrypt,
kms:Decrypt

Read

backup-gateway:GetHypervisor,
backup-gateway:ListHypervisors

Update

backup-gateway:UpdateHypervisor,
backup-gateway:GetHypervisor,
backup-gateway:ListHypervisors,
backup-gateway:ImportHypervisorConfiguration,
backup-gateway:DeleteHypervisor

Delete

backup-gateway:DeleteHypervisor,
backup-gateway:GetHypervisor,
backup-gateway:ListHypervisors

List

backup-gateway:ListHypervisors