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	aws.vpclattice.resource_gateways

Fields

Name	Datatype	Description
ip_address_type	string
vpc_identifier	string
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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all resource_gateways in a region.

SELECT
region,
ip_address_type,
vpc_identifier,
id,
arn,
subnet_ids,
security_group_ids,
tags,
name
FROM aws.vpclattice.resource_gateways
WHERE region = 'us-east-1';

Gets all properties from an individual resource_gateway.

SELECT
region,
ip_address_type,
vpc_identifier,
id,
arn,
subnet_ids,
security_group_ids,
tags,
name
FROM aws.vpclattice.resource_gateways
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.vpclattice.resource_gateways (
 IpAddressType,
 VpcIdentifier,
 SubnetIds,
 SecurityGroupIds,
 Tags,
 Name,
 region
)
SELECT 
'{{ IpAddressType }}',
 '{{ VpcIdentifier }}',
 '{{ SubnetIds }}',
 '{{ SecurityGroupIds }}',
 '{{ Tags }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.vpclattice.resource_gateways (
 IpAddressType,
 VpcIdentifier,
 SubnetIds,
 SecurityGroupIds,
 Tags,
 Name,
 region
)
SELECT 
 '{{ IpAddressType }}',
 '{{ VpcIdentifier }}',
 '{{ SubnetIds }}',
 '{{ SecurityGroupIds }}',
 '{{ Tags }}',
 '{{ Name }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_gateway
    props:
      - name: IpAddressType
        value: '{{ IpAddressType }}'
      - name: VpcIdentifier
        value: '{{ VpcIdentifier }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Name
        value: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.vpclattice.resource_gateways
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

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