resource_gateways

Creates, updates, deletes or gets a resource_gateway resource or lists resource_gateways in a region

Overview

Name	resource_gateways
Type	Resource
Description	Creates a resource gateway for a service.
Id	awscc.vpclattice.resource_gateways

Fields

get (all properties)

Name	Datatype	Description
ip_address_type	string
vpc_identifier	string
ipv4_addresses_per_eni	integer	The number of IPv4 addresses to allocate per ENI for the resource gateway
id	string
arn	string
subnet_ids	array	The ID of one or more subnets in which to create an endpoint network interface.
security_group_ids	array	The ID of one or more security groups to associate with the endpoint network interface.
▶tags	array
name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::VpcLattice::ResourceGateway.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resource_gateways	INSERT	Name, VpcIdentifier, SubnetIds, region
delete_resource	resource_gateways	DELETE	Identifier, region
update_resource	resource_gateways	UPDATE	Identifier, PatchDocument, region
list_resources	resource_gateways_list_only	SELECT	region
get_resource	resource_gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource_gateway.

SELECT
  region,
  ip_address_type,
  vpc_identifier,
  ipv4_addresses_per_eni,
  id,
  arn,
  subnet_ids,
  security_group_ids,
  tags,
  name
FROM awscc.vpclattice.resource_gateways
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all resource_gateways in a region.

SELECT
  region,
  arn
FROM awscc.vpclattice.resource_gateways_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new resource_gateway resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.vpclattice.resource_gateways (
  VpcIdentifier,
  SubnetIds,
  Name,
  region
)
SELECT
  '{{ vpc_identifier }}',
  '{{ subnet_ids }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.vpclattice.resource_gateways (
  IpAddressType,
  VpcIdentifier,
  Ipv4AddressesPerEni,
  SubnetIds,
  SecurityGroupIds,
  Tags,
  Name,
  region
)
SELECT
  '{{ ip_address_type }}',
  '{{ vpc_identifier }}',
  '{{ ipv4_addresses_per_eni }}',
  '{{ subnet_ids }}',
  '{{ security_group_ids }}',
  '{{ tags }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: resource_gateway
  props:
    - name: ip_address_type
      value: '{{ ip_address_type }}'
    - name: vpc_identifier
      value: '{{ vpc_identifier }}'
    - name: ipv4_addresses_per_eni
      value: '{{ ipv4_addresses_per_eni }}'
    - name: subnet_ids
      value:
        - '{{ subnet_ids[0] }}'
    - name: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: name
      value: '{{ name }}'

UPDATE example

Use the following StackQL query and manifest file to update a resource_gateway resource, using stack-deploy.

/*+ update */
UPDATE awscc.vpclattice.resource_gateways
SET PatchDocument = string('{{ {
    "Ipv4AddressesPerEni": ipv4_addresses_per_eni,
    "SecurityGroupIds": security_group_ids,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.vpclattice.resource_gateways
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the resource_gateways resource, the following permissions are required:

Read

vpc-lattice:GetResourceGateway,
vpc-lattice:ListTagsForResource

Create

vpc-lattice:CreateResourceGateway,
vpc-lattice:GetResourceGateway,
vpc-lattice:TagResource,
vpc-lattice:ListTagsForResource,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Update

vpc-lattice:UpdateResourceGateway,
vpc-lattice:GetResourceGateway,
vpc-lattice:TagResource,
vpc-lattice:UntagResource,
vpc-lattice:ListTagsForResource,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

List

vpc-lattice:ListResourceGateways

Delete

vpc-lattice:DeleteResourceGateway,
vpc-lattice:GetResourceGateway,
vpc-lattice:UntagResource