vpc_connections

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

Overview

Name	vpc_connections
Type	Resource
Id	aws.quicksight.vpc_connections

Fields

The following fields are returned by SELECT queries:

describe_vpc_connection

Name	Datatype	Description
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
vpc_connection	object	A response object that provides information for the specified VPC connection.

list_vpc_connections

Name	Datatype	Description
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
vpc_connection_summaries	array	A VPCConnectionSummaries object that returns a summary of VPC connection objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_connection	select	aws_account_id, vpc_connection_id, region		Describes a VPC connection.
list_vpc_connections	select	aws_account_id, region	next-token, max-results	Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
create_vpc_connection	insert	aws_account_id, region, VPCConnectionId, Name, SubnetIds, SecurityGroupIds, RoleArn		Creates a new VPC connection.
update_vpc_connection	update	aws_account_id, vpc_connection_id, region, Name, SubnetIds, SecurityGroupIds, RoleArn		Updates a VPC connection.
delete_vpc_connection	delete	aws_account_id, vpc_connection_id, region		Deletes a VPC connection.

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
aws_account_id	string	The Amazon Web Services account ID of the account where you want to delete a VPC connection.
region	string	AWS region (default: us-east-1)
vpc_connection_id	string	The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_vpc_connection

Describes a VPC connection.

SELECT
request_id,
status,
vpc_connection
FROM aws.quicksight.vpc_connections
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND vpc_connection_id = '{{ vpc_connection_id }}' -- required
AND region = '{{ region }}' -- required
;

list_vpc_connections

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

SELECT
next_token,
request_id,
status,
vpc_connection_summaries
FROM aws.quicksight.vpc_connections
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_vpc_connection

Creates a new VPC connection.

INSERT INTO aws.quicksight.vpc_connections (
VPCConnectionId,
Name,
SubnetIds,
SecurityGroupIds,
DnsResolvers,
RoleArn,
Tags,
aws_account_id,
region
)
SELECT 
'{{ VPCConnectionId }}' /* required */,
'{{ Name }}' /* required */,
'{{ SubnetIds }}' /* required */,
'{{ SecurityGroupIds }}' /* required */,
'{{ DnsResolvers }}',
'{{ RoleArn }}' /* required */,
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
availability_status,
creation_status,
request_id,
status,
vpc_connection_id
;

Manifest

# Description fields are for documentation purposes
- name: vpc_connections
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the vpc_connections resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_connections resource.
  - name: VPCConnectionId
    value: "{{ VPCConnectionId }}"
  - name: Name
    value: "{{ Name }}"
  - name: SubnetIds
    value:
      - "{{ SubnetIds }}"
  - name: SecurityGroupIds
    value:
      - "{{ SecurityGroupIds }}"
  - name: DnsResolvers
    value:
      - "{{ DnsResolvers }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_vpc_connection

Updates a VPC connection.

UPDATE aws.quicksight.vpc_connections
SET 
Name = '{{ Name }}',
SubnetIds = '{{ SubnetIds }}',
SecurityGroupIds = '{{ SecurityGroupIds }}',
DnsResolvers = '{{ DnsResolvers }}',
RoleArn = '{{ RoleArn }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND vpc_connection_id = '{{ vpc_connection_id }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND SubnetIds = '{{ SubnetIds }}' --required
AND SecurityGroupIds = '{{ SecurityGroupIds }}' --required
AND RoleArn = '{{ RoleArn }}' --required
RETURNING
arn,
availability_status,
request_id,
status,
update_status,
vpc_connection_id;

DELETE examples

delete_vpc_connection

Deletes a VPC connection.

DELETE FROM aws.quicksight.vpc_connections
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND vpc_connection_id = '{{ vpc_connection_id }}' --required
AND region = '{{ region }}' --required
;