vpc_links

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

Overview

Name	vpc_links
Type	Resource
Id	aws.apigateway.vpc_links

Fields

The following fields are returned by SELECT queries:

get_vpc_link

Name	Datatype	Description
id	string	The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name	string	The name used to label and identify the VPC link.
description	string	The description of the VPC link.
status	string	The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING. (AVAILABLE, PENDING, DELETING, FAILED)
status_message	string	A description about the VPC link status.
tags	object	The collection of tags. Each tag element is associated with a given resource.
target_arns	array	The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

get_vpc_links

Name	Datatype	Description
id	string	The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name	string	The name used to label and identify the VPC link.
description	string	The description of the VPC link.
status	string	The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING. (AVAILABLE, PENDING, DELETING, FAILED)
status_message	string	A description about the VPC link status.
tags	object	The collection of tags. Each tag element is associated with a given resource.
target_arns	array	The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpc_link	select	vpclink_id, region		Gets a specified VPC link under the caller's account in a region.
get_vpc_links	select	region	position, limit	Gets the VpcLinks collection under the caller's account in a selected region.
create_vpc_link	insert	region, name, targetArns		Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
update_vpc_link	update	vpclink_id, region		Updates an existing VpcLink of a specified identifier.
delete_vpc_link	delete	vpclink_id, region		Deletes an existing VpcLink of a specified identifier.

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)
vpclink_id	string	The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_vpc_link

Gets a specified VPC link under the caller's account in a region.

SELECT
id,
name,
description,
status,
status_message,
tags,
target_arns
FROM aws.apigateway.vpc_links
WHERE vpclink_id = '{{ vpclink_id }}' -- required
AND region = '{{ region }}' -- required
;

get_vpc_links

Gets the VpcLinks collection under the caller's account in a selected region.

SELECT
id,
name,
description,
status,
status_message,
tags,
target_arns
FROM aws.apigateway.vpc_links
WHERE region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_vpc_link

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

INSERT INTO aws.apigateway.vpc_links (
name,
description,
targetArns,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ targetArns }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
description,
status,
status_message,
tags,
target_arns
;

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 }}"
  - name: description
    value: "{{ description }}"
  - name: targetArns
    value:
      - "{{ targetArns }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_vpc_link

Updates an existing VpcLink of a specified identifier.

UPDATE aws.apigateway.vpc_links
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
vpclink_id = '{{ vpclink_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
description,
status,
status_message,
tags,
target_arns;

DELETE examples

delete_vpc_link

Deletes an existing VpcLink of a specified identifier.

DELETE FROM aws.apigateway.vpc_links
WHERE vpclink_id = '{{ vpclink_id }}' --required
AND region = '{{ region }}' --required
;