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	awscc.backupgateway.hypervisors

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
hypervisor_arn	string
region	string	AWS region.

For more information, see AWS::BackupGateway::Hypervisor.

Methods

Name	Resource	Accessible by	Required Params
create_resource	hypervisors	INSERT	region
delete_resource	hypervisors	DELETE	Identifier, region
update_resource	hypervisors	UPDATE	Identifier, PatchDocument, region
list_resources	hypervisors_list_only	SELECT	region
get_resource	hypervisors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual hypervisor.

SELECT
  region,
  host,
  hypervisor_arn,
  kms_key_arn,
  log_group_arn,
  name,
  password,
  tags,
  username
FROM awscc.backupgateway.hypervisors
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ hypervisor_arn }}';

list (identifiers only)

Lists all hypervisors in a region.

SELECT
  region,
  hypervisor_arn
FROM awscc.backupgateway.hypervisors_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.backupgateway.hypervisors (
  Host,
  KmsKeyArn,
  LogGroupArn,
  Name,
  Password,
  Tags,
  Username,
  region
)
SELECT
  '{{ host }}',
  '{{ kms_key_arn }}',
  '{{ log_group_arn }}',
  '{{ name }}',
  '{{ password }}',
  '{{ tags }}',
  '{{ username }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.backupgateway.hypervisors (
  Host,
  KmsKeyArn,
  LogGroupArn,
  Name,
  Password,
  Tags,
  Username,
  region
)
SELECT
  '{{ host }}',
  '{{ kms_key_arn }}',
  '{{ log_group_arn }}',
  '{{ 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: kms_key_arn
        value: '{{ kms_key_arn }}'
      - name: log_group_arn
        value: '{{ log_group_arn }}'
      - name: name
        value: '{{ name }}'
      - name: password
        value: '{{ password }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: username
        value: '{{ username }}'

UPDATE example

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

/*+ update */
UPDATE awscc.backupgateway.hypervisors
SET PatchDocument = string('{{ {
    "Host": host,
    "LogGroupArn": log_group_arn,
    "Name": name,
    "Password": password,
    "Username": username
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ hypervisor_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.backupgateway.hypervisors
WHERE
  Identifier = '{{ hypervisor_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

backup-gateway:ListTagsForResource,
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,
backup-gateway:ListTagsForResource

Update

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

Delete

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

List

backup-gateway:ListHypervisors