resource_gateways

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

Overview

Name	resource_gateways
Type	Resource
Id	aws.vpc_lattice.resource_gateways

Fields

The following fields are returned by SELECT queries:

get_resource_gateway

Name	Datatype	Description
id	string	The ID of the resource gateway. (pattern: <code>rgw-[0-9a-z]{17}</code>)
name	string	The name of the resource gateway. (pattern: <code>(?!rgw-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
arn	string	The Amazon Resource Name (ARN) of the resource gateway. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}</code>)
created_at	string (date-time)	The date and time that the resource gateway was created, in ISO-8601 format.
ip_address_type	string	The type of IP address for the resource gateway. (IPV4, IPV6, DUALSTACK)
ipv_4_addresses_per_eni	integer	The number of IPv4 addresses in each ENI for the resource gateway.
last_updated_at	string (date-time)	The date and time that the resource gateway was last updated, in ISO-8601 format.
managed_by	string	The Amazon Web Services service that manages the resource gateway.
resource_config_dns_resolution	string	The DNS resolution type for resource configurations that are associated with this resource gateway. (IN_VPC, PUBLIC)
security_group_ids	array	The security group IDs associated with the resource gateway.
service_managed	boolean	Indicates whether the resource gateway is managed by an Amazon Web Services service.
status	string	The status for the resource gateway. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
subnet_ids	array	The IDs of the VPC subnets for resource gateway.
vpc_id	string	The ID of the VPC for the resource gateway. (pattern: <code>vpc-(([0-9a-z]{8})|([0-9a-z]{17}))</code>)

list_resource_gateways

Name	Datatype	Description
id	string	The ID of the resource gateway. (pattern: <code>rgw-[0-9a-z]{17}</code>)
name	string	The name of the resource gateway. (pattern: <code>(?!rgw-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
arn	string	The Amazon Resource Name (ARN) of the resource gateway. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}</code>)
created_at	string (date-time)	The date and time that the VPC endpoint association was created, in ISO-8601 format.
ip_address_type	string	The type of IP address used by the resource gateway. (IPV4, IPV6, DUALSTACK)
ipv_4_addresses_per_eni	integer	The number of IPv4 addresses in each ENI for the resource gateway.
last_updated_at	string (date-time)	The most recent date and time that the resource gateway was updated, in ISO-8601 format.
resource_config_dns_resolution	string	The DNS resolution type for resource configurations that are associated with this resource gateway. (IN_VPC, PUBLIC)
security_group_ids	array	The IDs of the security groups applied to the resource gateway.
status	string	The name of the resource gateway. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, DELETE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
subnet_ids	array	The IDs of the VPC subnets for the resource gateway.
vpc_identifier	string	The ID of the VPC for the resource gateway. (pattern: <code>vpc-(([0-9a-z]{8})|([0-9a-z]{17}))</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_gateway	select	resource_gateway_identifier, region		Retrieves information about the specified resource gateway.
list_resource_gateways	select	region	maxResults, nextToken	Lists the resource gateways that you own or that were shared with you.
create_resource_gateway	insert	region, name		A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.
update_resource_gateway	update	resource_gateway_identifier, region		Updates the specified resource gateway.
delete_resource_gateway	delete	resource_gateway_identifier, region		Deletes the specified resource 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
region	string	AWS region (default: us-east-1)
resource_gateway_identifier	string	The ID or ARN of the resource gateway.
maxResults	integer	The maximum page size.
nextToken	string	If there are additional results, a pagination token for the next page of results.

SELECT examples

get_resource_gateway

Retrieves information about the specified resource gateway.

SELECT
id,
name,
arn,
created_at,
ip_address_type,
ipv_4_addresses_per_eni,
last_updated_at,
managed_by,
resource_config_dns_resolution,
security_group_ids,
service_managed,
status,
subnet_ids,
vpc_id
FROM aws.vpc_lattice.resource_gateways
WHERE resource_gateway_identifier = '{{ resource_gateway_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_resource_gateways

Lists the resource gateways that you own or that were shared with you.

SELECT
id,
name,
arn,
created_at,
ip_address_type,
ipv_4_addresses_per_eni,
last_updated_at,
resource_config_dns_resolution,
security_group_ids,
status,
subnet_ids,
vpc_identifier
FROM aws.vpc_lattice.resource_gateways
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_resource_gateway

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

INSERT INTO aws.vpc_lattice.resource_gateways (
clientToken,
name,
vpcIdentifier,
subnetIds,
securityGroupIds,
ipAddressType,
ipv4AddressesPerEni,
resourceConfigDnsResolution,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ vpcIdentifier }}',
'{{ subnetIds }}',
'{{ securityGroupIds }}',
'{{ ipAddressType }}',
{{ ipv4AddressesPerEni }},
'{{ resourceConfigDnsResolution }}',
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
ip_address_type,
ipv_4_addresses_per_eni,
resource_config_dns_resolution,
security_group_ids,
status,
subnet_ids,
vpc_identifier
;

Manifest

# Description fields are for documentation purposes
- name: resource_gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the resource_gateways resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: vpcIdentifier
    value: "{{ vpcIdentifier }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
  - name: ipAddressType
    value: "{{ ipAddressType }}"
    valid_values: ['IPV4', 'IPV6', 'DUALSTACK']
  - name: ipv4AddressesPerEni
    value: {{ ipv4AddressesPerEni }}
  - name: resourceConfigDnsResolution
    value: "{{ resourceConfigDnsResolution }}"
    valid_values: ['IN_VPC', 'PUBLIC']
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_resource_gateway

Updates the specified resource gateway.

UPDATE aws.vpc_lattice.resource_gateways
SET 
securityGroupIds = '{{ securityGroupIds }}'
WHERE 
resource_gateway_identifier = '{{ resource_gateway_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
arn,
ip_address_type,
security_group_ids,
status,
subnet_ids,
vpc_id;

DELETE examples

delete_resource_gateway

Deletes the specified resource gateway.

DELETE FROM aws.vpc_lattice.resource_gateways
WHERE resource_gateway_identifier = '{{ resource_gateway_identifier }}' --required
AND region = '{{ region }}' --required
;