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	Definition of the AWS::QuickSight::VPCConnection Resource Type.
Id	aws.quicksight.vpc_connections

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the VPC connection.
availability_status	string
aws_account_id	string
created_time	string	The time that the VPC connection was created.
dns_resolvers	array
last_updated_time	string	The time that the VPC connection was last updated.
name	string
network_interfaces	array	A list of network interfaces.
role_arn	string
security_group_ids	array
status	string
subnet_ids	array
tags	array
vpc_connection_id	string
vpc_id	string	The Amazon EC2 VPC ID associated with the VPC connection.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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,
availability_status,
aws_account_id,
created_time,
dns_resolvers,
last_updated_time,
name,
network_interfaces,
role_arn,
security_group_ids,
status,
subnet_ids,
tags,
vpc_connection_id,
vpc_id
FROM aws.quicksight.vpc_connections
WHERE region = 'us-east-1';

Gets all properties from an individual vpc_connection.

SELECT
region,
arn,
availability_status,
aws_account_id,
created_time,
dns_resolvers,
last_updated_time,
name,
network_interfaces,
role_arn,
security_group_ids,
status,
subnet_ids,
tags,
vpc_connection_id,
vpc_id
FROM aws.quicksight.vpc_connections
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<VPCConnectionId>';

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.quicksight.vpc_connections (
 AvailabilityStatus,
 AwsAccountId,
 DnsResolvers,
 Name,
 RoleArn,
 SecurityGroupIds,
 SubnetIds,
 Tags,
 VPCConnectionId,
 region
)
SELECT 
'{{ AvailabilityStatus }}',
 '{{ AwsAccountId }}',
 '{{ DnsResolvers }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ Tags }}',
 '{{ VPCConnectionId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.vpc_connections (
 AvailabilityStatus,
 AwsAccountId,
 DnsResolvers,
 Name,
 RoleArn,
 SecurityGroupIds,
 SubnetIds,
 Tags,
 VPCConnectionId,
 region
)
SELECT 
 '{{ AvailabilityStatus }}',
 '{{ AwsAccountId }}',
 '{{ DnsResolvers }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ Tags }}',
 '{{ VPCConnectionId }}',
 '{{ 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: AvailabilityStatus
        value: '{{ AvailabilityStatus }}'
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: DnsResolvers
        value:
          - '{{ DnsResolvers[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: VPCConnectionId
        value: '{{ VPCConnectionId }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.vpc_connections
WHERE data__Identifier = '<AwsAccountId|VPCConnectionId>'
AND region = 'us-east-1';

Permissions

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

Create

quicksight:CreateVPCConnection,
quicksight:DescribeVPCConnection,
quicksight:ListTagsForResource,
quicksight:TagResource,
iam:PassRole

Read

quicksight:DescribeVPCConnection,
quicksight:ListTagsForResource

Update

quicksight:DescribeVPCConnection,
quicksight:UpdateVPCConnection,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource,
iam:PassRole

Delete

quicksight:DescribeVPCConnection,
quicksight:DeleteVPCConnection,
quicksight:ListTagsForResource,
iam:PassRole

List

quicksight:ListVPCConnections