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	awscc.quicksight.vpc_connections

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
aws_account_id	string
vpc_connection_id	string
region	string	AWS region.

For more information, see AWS::QuickSight::VPCConnection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_connections	INSERT	region
delete_resource	vpc_connections	DELETE	Identifier, region
update_resource	vpc_connections	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_connections_list_only	SELECT	region
get_resource	vpc_connections	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.quicksight.vpc_connections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ vpc_connection_id }}';

list (identifiers only)

Lists all vpc_connections in a region.

SELECT
  region,
  aws_account_id,
  vpc_connection_id
FROM awscc.quicksight.vpc_connections_list_only
WHERE
  region = '{{ region }}';

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 awscc.quicksight.vpc_connections (
  AvailabilityStatus,
  AwsAccountId,
  DnsResolvers,
  Name,
  RoleArn,
  SecurityGroupIds,
  SubnetIds,
  Tags,
  VPCConnectionId,
  region
)
SELECT
  '{{ availability_status }}',
  '{{ aws_account_id }}',
  '{{ dns_resolvers }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ tags }}',
  '{{ vpc_connection_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.quicksight.vpc_connections (
  AvailabilityStatus,
  AwsAccountId,
  DnsResolvers,
  Name,
  RoleArn,
  SecurityGroupIds,
  SubnetIds,
  Tags,
  VPCConnectionId,
  region
)
SELECT
  '{{ availability_status }}',
  '{{ aws_account_id }}',
  '{{ dns_resolvers }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ tags }}',
  '{{ vpc_connection_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: vpc_connection
  props:
    - name: availability_status
      value: '{{ availability_status }}'
    - name: aws_account_id
      value: '{{ aws_account_id }}'
    - name: dns_resolvers
      value:
        - '{{ dns_resolvers[0] }}'
    - name: name
      value: '{{ name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: subnet_ids
      value:
        - '{{ subnet_ids[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: vpc_connection_id
      value: '{{ vpc_connection_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.quicksight.vpc_connections
SET PatchDocument = string('{{ {
    "AvailabilityStatus": availability_status,
    "DnsResolvers": dns_resolvers,
    "Name": name,
    "RoleArn": role_arn,
    "SecurityGroupIds": security_group_ids,
    "SubnetIds": subnet_ids,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ vpc_connection_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.vpc_connections
WHERE
  Identifier = '{{ aws_account_id }}|{{ vpc_connection_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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