requester_gateways

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

Overview

Name	requester_gateways
Type	Resource
Id	aws.rtbfabric.requester_gateways

Fields

The following fields are returned by SELECT queries:

get_requester_gateway

Name	Datatype	Description
active_links_count	integer	The count of active links for the requester gateway.
created_at	string (date-time)	The timestamp of when the requester gateway was created.
description	string	The description of the requester gateway. (pattern: <code>[A-Za-z0-9 ]+</code>)
domain_name	string	The domain name of the requester 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>)
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 requester gateway.
updated_at	string (date-time)	The timestamp of when the requester 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_requester_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_requester_gateway	select	gateway_id, region		Retrieves information about a requester gateway.
list_requester_gateways	select	region	maxResults, nextToken	Lists requester gateways.
create_requester_gateway	insert	region, vpcId, subnetIds, securityGroupIds, clientToken		Creates a requester gateway.
update_requester_gateway	update	gateway_id, region, clientToken		Updates a requester gateway.
delete_requester_gateway	delete	gateway_id, region		Deletes a requester 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_requester_gateway

Retrieves information about a requester gateway.

SELECT
active_links_count,
created_at,
description,
domain_name,
gateway_id,
security_group_ids,
status,
subnet_ids,
tags,
total_links_count,
updated_at,
vpc_id
FROM aws.rtbfabric.requester_gateways
WHERE gateway_id = '{{ gateway_id }}' -- required
AND region = '{{ region }}' -- required
;

list_requester_gateways

Lists requester gateways.

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

INSERT examples

create_requester_gateway

Creates a requester gateway.

INSERT INTO aws.rtbfabric.requester_gateways (
vpcId,
subnetIds,
securityGroupIds,
clientToken,
description,
tags,
region
)
SELECT 
'{{ vpcId }}' /* required */,
'{{ subnetIds }}' /* required */,
'{{ securityGroupIds }}' /* required */,
'{{ clientToken }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ region }}'
RETURNING
domain_name,
gateway_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: requester_gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the requester_gateways resource.
  - name: vpcId
    value: "{{ vpcId }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_requester_gateway

Updates a requester gateway.

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

DELETE examples

delete_requester_gateway

Deletes a requester gateway.

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