client_vpc_connections

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

Overview

Name	client_vpc_connections
Type	Resource
Id	aws.kafka.client_vpc_connections

Fields

The following fields are returned by SELECT queries:

list_client_vpc_connections

Name	Datatype	Description
authentication	string	Information about the auth scheme of Vpc Connection.
creation_time	string (date-time)	Creation time of the Vpc Connection.
owner	string	The Owner of the Vpc Connection.
state	string	State of the Vpc Connection. (CREATING, AVAILABLE, INACTIVE, DEACTIVATING, DELETING, FAILED, REJECTED, REJECTING)
vpc_connection_arn	string	The ARN that identifies the Vpc Connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_client_vpc_connections	select	cluster_arn, region	maxResults, nextToken	Returns a list of all the VPC connections in this Region.

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
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
nextToken	string	The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

SELECT examples

list_client_vpc_connections

Returns a list of all the VPC connections in this Region.

SELECT
authentication,
creation_time,
owner,
state,
vpc_connection_arn
FROM aws.kafka.client_vpc_connections
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;