responder_gateways

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

Overview

Name	responder_gateways
Type	Resource
Id	aws.rtbfabric.responder_gateways

Fields

The following fields are returned by SELECT queries:

get_responder_gateway

Name	Datatype	Description
active_links_count	integer	The count of active links for the responder gateway.
created_at	string (date-time)	The timestamp of when the responder gateway was created.
description	string	The description of the responder gateway. (pattern: <code>[A-Za-z0-9 ]+</code>)
domain_name	string	The domain name of the responder gateway. (pattern: <code>(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+</code>)
external_inbound_endpoint	string	The external inbound endpoint for the responder gateway. (pattern: <code>(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+</code>)
gateway_id	string	The unique identifier of the gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>)
gateway_type	string	The type of gateway. (EXTERNAL, INTERNAL)
links_requested_count	integer	The count of requested links waiting for the responder gateway to accept or reject.
listener_config	object	Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
managed_endpoint_configuration	object	Describes the configuration of a managed endpoint.
port	integer	The networking port.
protocol	string	The networking protocol. (HTTP, HTTPS)
security_group_ids	array	The unique identifiers of the security groups.
status	string	The status of the request. (PENDING_CREATION, ACTIVE, PENDING_DELETION, DELETED, ERROR, PENDING_UPDATE, ISOLATED, PENDING_ISOLATION, PENDING_RESTORATION)
subnet_ids	array	The unique identifiers of the subnets.
tags	object	A map of the key-value pairs for the tag or tags assigned to the specified resource.
total_links_count	integer	The total count of links for the responder gateway.
trust_store_configuration	object	Describes the configuration of a trust store.
updated_at	string (date-time)	The timestamp of when the responder gateway was updated.
vpc_id	string	The unique identifier of the Virtual Private Cloud (VPC). (pattern: <code>vpc-[a-f0-9]{8,17}</code>)

list_responder_gateways

Name	Datatype	Description
gateway_id	string	The unique identifier of the gateways.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_responder_gateway	select	gateway_id, region		Retrieves information about a responder gateway.
list_responder_gateways	select	region	maxResults, nextToken	Lists reponder gateways.
create_responder_gateway	insert	region, vpcId, subnetIds, securityGroupIds, port, protocol, clientToken		Creates a responder gateway. A domain name or managed endpoint is required.
update_responder_gateway	update	gateway_id, region, port, protocol, clientToken		Updates a responder gateway.
delete_responder_gateway	delete	gateway_id, region		Deletes a responder gateway.

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.
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_responder_gateway

Retrieves information about a responder gateway.

SELECT
active_links_count,
created_at,
description,
domain_name,
external_inbound_endpoint,
gateway_id,
gateway_type,
links_requested_count,
listener_config,
managed_endpoint_configuration,
port,
protocol,
security_group_ids,
status,
subnet_ids,
tags,
total_links_count,
trust_store_configuration,
updated_at,
vpc_id
FROM aws.rtbfabric.responder_gateways
WHERE gateway_id = '{{ gateway_id }}' -- required
AND region = '{{ region }}' -- required
;

list_responder_gateways

Lists reponder gateways.

SELECT
gateway_id
FROM aws.rtbfabric.responder_gateways
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_responder_gateway

Creates a responder gateway. A domain name or managed endpoint is required.

INSERT INTO aws.rtbfabric.responder_gateways (
vpcId,
subnetIds,
securityGroupIds,
domainName,
port,
protocol,
listenerConfig,
trustStoreConfiguration,
managedEndpointConfiguration,
clientToken,
description,
tags,
gatewayType,
region
)
SELECT 
'{{ vpcId }}' /* required */,
'{{ subnetIds }}' /* required */,
'{{ securityGroupIds }}' /* required */,
'{{ domainName }}',
{{ port }} /* required */,
'{{ protocol }}' /* required */,
'{{ listenerConfig }}',
'{{ trustStoreConfiguration }}',
'{{ managedEndpointConfiguration }}',
'{{ clientToken }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ gatewayType }}',
'{{ region }}'
RETURNING
external_inbound_endpoint,
gateway_id,
listener_config,
status
;

Manifest

# Description fields are for documentation purposes
- name: responder_gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the responder_gateways resource.
  - name: vpcId
    value: "{{ vpcId }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
  - name: domainName
    value: "{{ domainName }}"
  - name: port
    value: {{ port }}
  - name: protocol
    value: "{{ protocol }}"
    valid_values: ['HTTP', 'HTTPS']
  - name: listenerConfig
    description: |
      Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
    value:
      protocols:
        - "{{ protocols }}"
  - name: trustStoreConfiguration
    description: |
      Describes the configuration of a trust store.
    value:
      certificateAuthorityCertificates:
        - "{{ certificateAuthorityCertificates }}"
  - name: managedEndpointConfiguration
    description: |
      Describes the configuration of a managed endpoint.
    value:
      autoScalingGroups:
        autoScalingGroupNames:
          - "{{ autoScalingGroupNames }}"
        roleArn: "{{ roleArn }}"
        healthCheckConfig:
          port: {{ port }}
          path: "{{ path }}"
          protocol: "{{ protocol }}"
          timeoutMs: {{ timeoutMs }}
          intervalSeconds: {{ intervalSeconds }}
          statusCodeMatcher: "{{ statusCodeMatcher }}"
          healthyThresholdCount: {{ healthyThresholdCount }}
          unhealthyThresholdCount: {{ unhealthyThresholdCount }}
      eksEndpoints:
        endpointsResourceName: "{{ endpointsResourceName }}"
        endpointsResourceNamespace: "{{ endpointsResourceNamespace }}"
        clusterApiServerEndpointUri: "{{ clusterApiServerEndpointUri }}"
        clusterApiServerCaCertificateChain: "{{ clusterApiServerCaCertificateChain }}"
        clusterName: "{{ clusterName }}"
        roleArn: "{{ roleArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: gatewayType
    value: "{{ gatewayType }}"
    description: |
      The type of gateway.
    valid_values: ['EXTERNAL', 'INTERNAL']

UPDATE examples

update_responder_gateway

Updates a responder gateway.

UPDATE aws.rtbfabric.responder_gateways
SET 
domainName = '{{ domainName }}',
port = {{ port }},
protocol = '{{ protocol }}',
listenerConfig = '{{ listenerConfig }}',
trustStoreConfiguration = '{{ trustStoreConfiguration }}',
managedEndpointConfiguration = '{{ managedEndpointConfiguration }}',
clientToken = '{{ clientToken }}',
description = '{{ description }}'
WHERE 
gateway_id = '{{ gateway_id }}' --required
AND region = '{{ region }}' --required
AND port = '{{ port }}' --required
AND protocol = '{{ protocol }}' --required
AND clientToken = '{{ clientToken }}' --required
RETURNING
gateway_id,
status;

DELETE examples

delete_responder_gateway

Deletes a responder gateway.

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