vpc_connections

Creates, updates, deletes or gets a vpc_connection resource or lists vpc_connections in a region

Overview

Name	vpc_connections
Type	Resource
Description	Resource Type definition for AWS::MSK::VpcConnection
Id	aws.msk.vpc_connections

Fields

Name	Datatype	Description
arn	string
authentication	string	The type of private link authentication
client_subnets	array
target_cluster_arn	string	The Amazon Resource Name (ARN) of the target cluster
security_groups	array
tags	object	A key-value pair to associate with a resource.
vpc_id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Authentication, ClientSubnets, SecurityGroups, TargetClusterArn, VpcId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vpc_connections in a region.

SELECT
region,
arn,
authentication,
client_subnets,
target_cluster_arn,
security_groups,
tags,
vpc_id
FROM aws.msk.vpc_connections
WHERE region = 'us-east-1';

Gets all properties from an individual vpc_connection.

SELECT
region,
arn,
authentication,
client_subnets,
target_cluster_arn,
security_groups,
tags,
vpc_id
FROM aws.msk.vpc_connections
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.msk.vpc_connections (
 Authentication,
 ClientSubnets,
 TargetClusterArn,
 SecurityGroups,
 VpcId,
 region
)
SELECT 
'{{ Authentication }}',
 '{{ ClientSubnets }}',
 '{{ TargetClusterArn }}',
 '{{ SecurityGroups }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.msk.vpc_connections (
 Authentication,
 ClientSubnets,
 TargetClusterArn,
 SecurityGroups,
 Tags,
 VpcId,
 region
)
SELECT 
 '{{ Authentication }}',
 '{{ ClientSubnets }}',
 '{{ TargetClusterArn }}',
 '{{ SecurityGroups }}',
 '{{ Tags }}',
 '{{ VpcId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_connection
    props:
      - name: Authentication
        value: '{{ Authentication }}'
      - name: ClientSubnets
        value:
          - '{{ ClientSubnets[0] }}'
      - name: TargetClusterArn
        value: '{{ TargetClusterArn }}'
      - name: SecurityGroups
        value:
          - '{{ SecurityGroups[0] }}'
      - name: Tags
        value: {}
      - name: VpcId
        value: '{{ VpcId }}'

DELETE example

/*+ delete */
DELETE FROM aws.msk.vpc_connections
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateVpcEndpoint,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcAttribute,
ec2:DescribeVpcs,
ec2:DescribeVpcEndpoints,
ec2:AcceptVpcEndpointConnections,
ec2:RejectVpcEndpointConnections,
ec2:DescribeVpcEndpointConnections,
ec2:CreateTags,
iam:AttachRolePolicy,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy,
kafka:CreateVpcConnection,
kafka:DescribeVpcConnection,
kafka:TagResource,
kms:CreateGrant,
kms:DescribeKey

Read

kafka:DescribeVpcConnection,
kms:CreateGrant,
kms:DescribeKey

Update

kafka:DescribeVpcConnection,
kms:CreateGrant,
kms:DescribeKey,
kafka:TagResource,
kafka:UntagResource

Delete

ec2:DeleteVpcEndpoint,
ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints,
ec2:DescribeVpcEndpointConnections,
kafka:DeleteVpcConnection,
kafka:DescribeVpcConnection,
kms:CreateGrant,
kms:DescribeKey

List

kafka:ListVpcConnections,
kms:CreateGrant,
kms:DescribeKey