vpc_links

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

Overview

Name	vpc_links
Type	Resource
Id	aws.apigatewayv2.vpc_links

Fields

The following fields are returned by SELECT queries:

get_vpc_link

Name	Datatype	Description
created_date	string (date-time)	The timestamp when the VPC link was created.
name	string	A string with a length between [1-128].
security_group_ids	array	A list of security group IDs for the VPC link.
subnet_ids	array	A list of subnet IDs to include in the VPC link.
tags	object	Tags for the VPC link.
vpc_link_id	string	The identifier.
vpc_link_status	string	The status of the VPC link. (PENDING, AVAILABLE, DELETING, FAILED, INACTIVE)
vpc_link_status_message	string	A string with a length between [0-1024].
vpc_link_version	string	The version of the VPC link. (V2)

get_vpc_links

Name	Datatype	Description
items	array	A collection of VPC links.
next_token	string	The next page of elements from this collection. Not valid for the last element of the collection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpc_link	select	vpc_link_id, region		Gets a VPC link.
get_vpc_links	select	region	maxResults, nextToken	Gets a collection of VPC links.
create_vpc_link	insert	region, SubnetIds		Creates a VPC link.
update_vpc_link	update	vpc_link_id, region		Updates a VPC link.
delete_vpc_link	delete	vpc_link_id, region		Deletes a VPC link.

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
region	string	AWS region (default: us-east-1)
vpc_link_id	string	The ID of the VPC link.
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.

SELECT examples

get_vpc_link

Gets a VPC link.

SELECT
created_date,
name,
security_group_ids,
subnet_ids,
tags,
vpc_link_id,
vpc_link_status,
vpc_link_status_message,
vpc_link_version
FROM aws.apigatewayv2.vpc_links
WHERE vpc_link_id = '{{ vpc_link_id }}' -- required
AND region = '{{ region }}' -- required
;

get_vpc_links

Gets a collection of VPC links.

SELECT
items,
next_token
FROM aws.apigatewayv2.vpc_links
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_vpc_link

Creates a VPC link.

INSERT INTO aws.apigatewayv2.vpc_links (
Name,
SecurityGroupIds,
SubnetIds,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ SecurityGroupIds }}',
'{{ SubnetIds }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
created_date,
name,
security_group_ids,
subnet_ids,
tags,
vpc_link_id,
vpc_link_status,
vpc_link_status_message,
vpc_link_version
;

Manifest

# Description fields are for documentation purposes
- name: vpc_links
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_links resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A string with a length between [1-128].
  - name: SecurityGroupIds
    value:
      - "{{ SecurityGroupIds }}"
    description: |
      A list of security group IDs for the VPC link.
  - name: SubnetIds
    value:
      - "{{ SubnetIds }}"
    description: |
      A list of subnet IDs to include in the VPC link.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Represents a collection of tags associated with the resource.

UPDATE examples

update_vpc_link

Updates a VPC link.

UPDATE aws.apigatewayv2.vpc_links
SET 
Name = '{{ Name }}'
WHERE 
vpc_link_id = '{{ vpc_link_id }}' --required
AND region = '{{ region }}' --required
RETURNING
created_date,
name,
security_group_ids,
subnet_ids,
tags,
vpc_link_id,
vpc_link_status,
vpc_link_status_message,
vpc_link_version;

DELETE examples

delete_vpc_link

Deletes a VPC link.

DELETE FROM aws.apigatewayv2.vpc_links
WHERE vpc_link_id = '{{ vpc_link_id }}' --required
AND region = '{{ region }}' --required
;