vpc_connections

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

Overview

Name	vpc_connections
Type	Resource
Id	aws.kafka.vpc_connections

Fields

The following fields are returned by SELECT queries:

describe_vpc_connection

Name	Datatype	Description
authentication	string	The authentication type of VPC connection.
creation_time	string (date-time)	The creation time of the VPC connection.
security_groups	array	The list of security groups for the VPC connection.
state	string	The state of VPC connection. (CREATING, AVAILABLE, INACTIVE, DEACTIVATING, DELETING, FAILED, REJECTED, REJECTING)
subnets	array	The list of subnets for the VPC connection.
tags	object	A map of tags for the VPC connection.
target_cluster_arn	string	The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.
vpc_connection_arn	string	The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.
vpc_id	string	The VPC Id for the VPC connection.

list_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.
state	string	State of the Vpc Connection. (CREATING, AVAILABLE, INACTIVE, DEACTIVATING, DELETING, FAILED, REJECTED, REJECTING)
target_cluster_arn	string	The ARN that identifies the Cluster which the Vpc Connection belongs to.
vpc_connection_arn	string	The ARN that identifies the Vpc Connection.
vpc_id	string	The vpcId that belongs to the Vpc Connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_connection	select	arn, region		Returns a description of this MSK VPC connection.
list_vpc_connections	select	region	maxResults, nextToken	Returns a list of all the VPC connections in this Region.
create_vpc_connection	insert	region, TargetClusterArn, VpcId, ClientSubnets, SecurityGroups		Creates a new MSK VPC connection.
delete_vpc_connection	delete	arn, region		Deletes a MSK VPC connection.
reject_client_vpc_connection	exec	cluster_arn, region, VpcConnectionArn		Returns empty response.

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
arn	string	The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.
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

describe_vpc_connection

Returns a description of this MSK VPC connection.

SELECT
authentication,
creation_time,
security_groups,
state,
subnets,
tags,
target_cluster_arn,
vpc_connection_arn,
vpc_id
FROM aws.kafka.vpc_connections
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_vpc_connections

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

SELECT
authentication,
creation_time,
state,
target_cluster_arn,
vpc_connection_arn,
vpc_id
FROM aws.kafka.vpc_connections
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_vpc_connection

Creates a new MSK VPC connection.

INSERT INTO aws.kafka.vpc_connections (
TargetClusterArn,
Authentication,
VpcId,
ClientSubnets,
SecurityGroups,
Tags,
region
)
SELECT 
'{{ TargetClusterArn }}' /* required */,
'{{ Authentication }}',
'{{ VpcId }}' /* required */,
'{{ ClientSubnets }}' /* required */,
'{{ SecurityGroups }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
authentication,
client_subnets,
creation_time,
security_groups,
state,
tags,
vpc_connection_arn,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: vpc_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_connections resource.
  - name: TargetClusterArn
    value: "{{ TargetClusterArn }}"
  - name: Authentication
    value: "{{ Authentication }}"
  - name: VpcId
    value: "{{ VpcId }}"
  - name: ClientSubnets
    value:
      - "{{ ClientSubnets }}"
  - name: SecurityGroups
    value:
      - "{{ SecurityGroups }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_vpc_connection

Deletes a MSK VPC connection.

DELETE FROM aws.kafka.vpc_connections
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

reject_client_vpc_connection

Returns empty response.

EXEC aws.kafka.vpc_connections.reject_client_vpc_connection 
@cluster_arn='{{ cluster_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"VpcConnectionArn": "{{ VpcConnectionArn }}"
}'
;