hypervisor_property_mappings

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

Overview

Name	hypervisor_property_mappings
Type	Resource
Id	aws.backup_gateway.hypervisor_property_mappings

Fields

The following fields are returned by SELECT queries:

get_hypervisor_property_mappings

Name	Datatype	Description
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>)
iam_role_arn	string	The Amazon Resource Name (ARN) of the IAM role. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)</code>)
vmware_to_aws_tag_mappings	array	This is a display of the mappings of VMware tags to the Amazon Web Services tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_hypervisor_property_mappings	select	region		This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.
put_hypervisor_property_mappings	replace	region, HypervisorArn, VmwareToAwsTagMappings, IamRoleArn		This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.

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_property_mappings

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.

SELECT
hypervisor_arn,
iam_role_arn,
vmware_to_aws_tag_mappings
FROM aws.backup_gateway.hypervisor_property_mappings
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_hypervisor_property_mappings

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.

REPLACE aws.backup_gateway.hypervisor_property_mappings
SET 
HypervisorArn = '{{ HypervisorArn }}',
VmwareToAwsTagMappings = '{{ VmwareToAwsTagMappings }}',
IamRoleArn = '{{ IamRoleArn }}'
WHERE 
region = '{{ region }}' --required
AND HypervisorArn = '{{ HypervisorArn }}' --required
AND VmwareToAwsTagMappings = '{{ VmwareToAwsTagMappings }}' --required
AND IamRoleArn = '{{ IamRoleArn }}' --required
RETURNING
hypervisor_arn;