gateway_route_table_associations

Creates, updates, deletes or gets a gateway_route_table_association resource or lists gateway_route_table_associations in a region

Overview

Name	gateway_route_table_associations
Type	Resource
Description	Associates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
Id	awscc.ec2.gateway_route_table_associations

Fields

Name	Datatype	Description
route_table_id	string	The ID of the route table.
gateway_id	string	The ID of the gateway.
association_id	string	The route table association ID.
region	string	AWS region.

For more information, see AWS::EC2::GatewayRouteTableAssociation.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RouteTableId, GatewayId, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual gateway_route_table_association.

SELECT
  region,
  route_table_id,
  gateway_id,
  association_id
FROM awscc.ec2.gateway_route_table_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ gateway_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.gateway_route_table_associations (
  RouteTableId,
  GatewayId,
  region
)
SELECT
  '{{ route_table_id }}',
  '{{ gateway_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.gateway_route_table_associations (
  RouteTableId,
  GatewayId,
  region
)
SELECT
  '{{ route_table_id }}',
  '{{ gateway_id }}',
  '{{ 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: gateway_route_table_association
  props:
    - name: route_table_id
      value: '{{ route_table_id }}'
    - name: gateway_id
      value: '{{ gateway_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.gateway_route_table_associations
SET PatchDocument = string('{{ {
    "RouteTableId": route_table_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ gateway_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.gateway_route_table_associations
WHERE
  Identifier = '{{ gateway_id }}' 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 gateway_route_table_associations resource, the following permissions are required:

Create

ec2:DescribeRouteTables,
ec2:AssociateRouteTable

Read

ec2:DescribeRouteTables

Update

ec2:DescribeRouteTables,
ec2:ReplaceRouteTableAssociation

Delete

ec2:DescribeRouteTables,
ec2:DisassociateRouteTable