links

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

Overview

Name	links
Type	Resource
Id	aws.rtbfabric.links

Fields

The following fields are returned by SELECT queries:

get_link

Name	Datatype	Description
attributes	object	Describes the attributes of a link.
connectivity_type	string	The connectivity type of the link. (DEFAULT, PUBLIC_INGRESS, PUBLIC_EGRESS, EXTERNAL_INBOUND)
created_at	string (date-time)	The timestamp of when the link was created.
direction	string	The direction of the link. (RESPONSE, REQUEST)
flow_modules	array	The configuration of flow modules.
gateway_id	string	The unique identifier of the gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>)
http_responder_allowed	boolean	Boolean to specify if an HTTP responder is allowed.
link_id	string	The unique identifier of the link. (pattern: <code>link-[a-z0-9-]{1,25}</code>)
log_settings	object	Describes the settings for a link log.
peer_gateway_id	string	The unique identifier of the peer gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>)
pending_flow_modules	array	The configuration of pending flow modules.
status	string	The status of the link. (PENDING_CREATION, PENDING_REQUEST, REQUESTED, ACCEPTED, ACTIVE, REJECTED, FAILED, PENDING_DELETION, DELETED, PENDING_UPDATE, PENDING_ISOLATION, ISOLATED, PENDING_RESTORATION)
tags	object	A map of the key-value pairs for the tag or tags assigned to the specified resource.
timeout_in_millis	integer (int64)	The timeout value in milliseconds.
updated_at	string (date-time)	The timestamp of when the link was updated.

list_links

Name	Datatype	Description
attributes	object	Describes the attributes of a link.
connectivity_type	string	The connectivity type of the link. (DEFAULT, PUBLIC_INGRESS, PUBLIC_EGRESS, EXTERNAL_INBOUND)
created_at	string (date-time)	The timestamp of when the link was created.
direction	string	The direction of the link. (RESPONSE, REQUEST)
flow_modules	array	Describes the configuration of flow modules.
gateway_id	string	The unique identifier of the gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>)
link_id	string	The unique identifier of the link. (pattern: <code>link-[a-z0-9-]{1,25}</code>)
log_settings	object	Describes the settings for a link log.
peer_gateway_id	string	The unique identifier of the peer gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>)
pending_flow_modules	array	Describes the configuration of pending flow modules.
public_endpoint	string	The public endpoint of the outbound link. (pattern: <code>(https|http):​//.+</code>)
status	string	The status of the link. (PENDING_CREATION, PENDING_REQUEST, REQUESTED, ACCEPTED, ACTIVE, REJECTED, FAILED, PENDING_DELETION, DELETED, PENDING_UPDATE, PENDING_ISOLATION, ISOLATED, PENDING_RESTORATION)
tags	object	A map of the key-value pairs of the tag or tags to assign to the resource.
updated_at	string (date-time)	The timestamp of when the link was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_link	select	gateway_id, link_id, region		Retrieves information about a link between gateways. Returns detailed information about the link configuration, status, and associated gateways.
list_links	select	gateway_id, region	nextToken, maxResults	Lists links associated with gateways. Returns a list of all links for the specified gateways, including their status and configuration details.
create_link	insert	gateway_id, region, peerGatewayId, logSettings		Creates a new link between gateways. Establishes a connection that allows gateways to communicate and exchange bid requests and responses.
update_link_module_flow	update	gateway_id, link_id, region, clientToken, modules		Updates a link module flow.
update_link	update	gateway_id, link_id, region		Updates the configuration of a link between gateways. Allows you to modify settings and parameters for an existing link.
delete_link	delete	gateway_id, link_id, region		Deletes a link between gateways. Permanently removes the connection between gateways. This action cannot be undone.
accept_link	exec	gateway_id, link_id, region, logSettings		Accepts a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.
reject_link	exec	gateway_id, link_id, region		Rejects a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.

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
gateway_id	string	The unique identifier of the gateway.
link_id	string	The unique identifier of the link.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken	string	If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

SELECT examples

get_link

Retrieves information about a link between gateways. Returns detailed information about the link configuration, status, and associated gateways.

SELECT
attributes,
connectivity_type,
created_at,
direction,
flow_modules,
gateway_id,
http_responder_allowed,
link_id,
log_settings,
peer_gateway_id,
pending_flow_modules,
status,
tags,
timeout_in_millis,
updated_at
FROM aws.rtbfabric.links
WHERE gateway_id = '{{ gateway_id }}' -- required
AND link_id = '{{ link_id }}' -- required
AND region = '{{ region }}' -- required
;

list_links

Lists links associated with gateways. Returns a list of all links for the specified gateways, including their status and configuration details.

SELECT
attributes,
connectivity_type,
created_at,
direction,
flow_modules,
gateway_id,
link_id,
log_settings,
peer_gateway_id,
pending_flow_modules,
public_endpoint,
status,
tags,
updated_at
FROM aws.rtbfabric.links
WHERE gateway_id = '{{ gateway_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_link

Creates a new link between gateways. Establishes a connection that allows gateways to communicate and exchange bid requests and responses.

INSERT INTO aws.rtbfabric.links (
peerGatewayId,
attributes,
httpResponderAllowed,
tags,
logSettings,
timeoutInMillis,
gateway_id,
region
)
SELECT 
'{{ peerGatewayId }}' /* required */,
'{{ attributes }}',
{{ httpResponderAllowed }},
'{{ tags }}',
'{{ logSettings }}' /* required */,
{{ timeoutInMillis }},
'{{ gateway_id }}',
'{{ region }}'
RETURNING
attributes,
connectivity_type,
created_at,
customer_provided_id,
direction,
flow_modules,
gateway_id,
link_id,
log_settings,
peer_gateway_id,
pending_flow_modules,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: links
props:
  - name: gateway_id
    value: "{{ gateway_id }}"
    description: Required parameter for the links resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the links resource.
  - name: peerGatewayId
    value: "{{ peerGatewayId }}"
  - name: attributes
    description: |
      Describes the attributes of a link.
    value:
      responderErrorMasking:
        - httpCode: "{{ httpCode }}"
          action: "{{ action }}"
          loggingTypes: "{{ loggingTypes }}"
          responseLoggingPercentage: {{ responseLoggingPercentage }}
      customerProvidedId: "{{ customerProvidedId }}"
  - name: httpResponderAllowed
    value: {{ httpResponderAllowed }}
  - name: tags
    value: "{{ tags }}"
  - name: logSettings
    description: |
      Describes the settings for a link log.
    value:
      applicationLogs:
        sampling:
          errorLog: {{ errorLog }}
          filterLog: {{ filterLog }}
  - name: timeoutInMillis
    value: {{ timeoutInMillis }}

UPDATE examples

update_link_module_flow

Updates a link module flow.

UPDATE aws.rtbfabric.links
SET 
clientToken = '{{ clientToken }}',
modules = '{{ modules }}'
WHERE 
gateway_id = '{{ gateway_id }}' --required
AND link_id = '{{ link_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}' --required
AND modules = '{{ modules }}' --required
RETURNING
gateway_id,
link_id,
status;

update_link

Updates the configuration of a link between gateways. Allows you to modify settings and parameters for an existing link.

UPDATE aws.rtbfabric.links
SET 
logSettings = '{{ logSettings }}',
timeoutInMillis = {{ timeoutInMillis }}
WHERE 
gateway_id = '{{ gateway_id }}' --required
AND link_id = '{{ link_id }}' --required
AND region = '{{ region }}' --required
RETURNING
link_id,
status;

DELETE examples

delete_link

Deletes a link between gateways. Permanently removes the connection between gateways. This action cannot be undone.

DELETE FROM aws.rtbfabric.links
WHERE gateway_id = '{{ gateway_id }}' --required
AND link_id = '{{ link_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

accept_link

Accepts a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.

EXEC aws.rtbfabric.links.accept_link 
@gateway_id='{{ gateway_id }}' --required, 
@link_id='{{ link_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"attributes": "{{ attributes }}", 
"logSettings": "{{ logSettings }}", 
"timeoutInMillis": {{ timeoutInMillis }}
}'
;

reject_link

Rejects a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.

EXEC aws.rtbfabric.links.reject_link 
@gateway_id='{{ gateway_id }}' --required, 
@link_id='{{ link_id }}' --required, 
@region='{{ region }}' --required
;