outbound_external_links

Creates, updates, deletes, gets or lists an outbound_external_links resource.

Overview

Name	outbound_external_links
Type	Resource
Id	aws.rtbfabric.outbound_external_links

Fields

The following fields are returned by SELECT queries:

get_outbound_external_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 outbound external link was created.
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>)
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.
pending_flow_modules	array	The configuration of pending flow modules.
public_endpoint	string	The public endpoint for the link. (pattern: <code>(https|http):​//.+</code>)
status	string	The status of the request. (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.
updated_at	string (date-time)	The timestamp of when the outbound external link was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_outbound_external_link	select	gateway_id, link_id, region		Retrieves information about an outbound external link.
create_outbound_external_link	insert	gateway_id, region, clientToken, publicEndpoint, logSettings		Creates an outbound external link.
delete_outbound_external_link	delete	gateway_id, link_id, region		Deletes an outbound external 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
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)

SELECT examples

get_outbound_external_link

Retrieves information about an outbound external link.

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

INSERT examples

create_outbound_external_link

Creates an outbound external link.

INSERT INTO aws.rtbfabric.outbound_external_links (
clientToken,
attributes,
publicEndpoint,
logSettings,
tags,
gateway_id,
region
)
SELECT 
'{{ clientToken }}' /* required */,
'{{ attributes }}',
'{{ publicEndpoint }}' /* required */,
'{{ logSettings }}' /* required */,
'{{ tags }}',
'{{ gateway_id }}',
'{{ region }}'
RETURNING
gateway_id,
link_id,
status
;

Manifest

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

DELETE examples

delete_outbound_external_link

Deletes an outbound external link.

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