vcenter_clients

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

Overview

Name	vcenter_clients
Type	Resource
Id	aws.mgn.vcenter_clients

Fields

The following fields are returned by SELECT queries:

describe_vcenter_clients

Name	Datatype	Description
arn	string	Arn of vCenter client.
datacenter_name	string	Datacenter name of vCenter client.
hostname	string	Hostname of vCenter client .
last_seen_datetime	string	Last seen time of vCenter client. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
source_server_tags	object	Tags for Source Server of vCenter client.
tags	object	Tags for vCenter client.
vcenter_client_id	string	ID of vCenter client. (pattern: <code>vcc-[0-9a-zA-Z]{17}</code>)
vcenter_uuid	string	Vcenter UUID of vCenter client.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vcenter_clients	select	region	maxResults, nextToken	Returns a list of the installed vCenter clients.
delete_vcenter_client	delete	region		Deletes a given vCenter client by ID.

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)
maxResults	integer	Maximum results to be returned in DescribeVcenterClients.
nextToken	string	Next pagination token to be provided for DescribeVcenterClients.

SELECT examples

describe_vcenter_clients

Returns a list of the installed vCenter clients.

SELECT
arn,
datacenter_name,
hostname,
last_seen_datetime,
source_server_tags,
tags,
vcenter_client_id,
vcenter_uuid
FROM aws.mgn.vcenter_clients
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_vcenter_client

Deletes a given vCenter client by ID.

DELETE FROM aws.mgn.vcenter_clients
WHERE region = '{{ region }}' --required
;