local_gateway_route_tablevpc_associations

Creates, updates, deletes or gets a local_gateway_route_tablevpc_association resource or lists local_gateway_route_tablevpc_associations in a region

Overview

Name	local_gateway_route_tablevpc_associations
Type	Resource
Description	Resource Type definition for Local Gateway Route Table VPC Association which describes an association between a local gateway route table and a VPC.
Id	awscc.ec2.local_gateway_route_tablevpc_associations

Fields

get (all properties)

Name	Datatype	Description
local_gateway_id	string	The ID of the local gateway.
local_gateway_route_table_id	string	The ID of the local gateway route table.
local_gateway_route_table_vpc_association_id	string	The ID of the association.
state	string	The state of the association.
vpc_id	string	The ID of the VPC.
▶tags	array	The tags for the association.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
local_gateway_route_table_vpc_association_id	string	The ID of the association.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	local_gateway_route_tablevpc_associations	INSERT	LocalGatewayRouteTableId, VpcId, region
delete_resource	local_gateway_route_tablevpc_associations	DELETE	Identifier, region
update_resource	local_gateway_route_tablevpc_associations	UPDATE	Identifier, PatchDocument, region
list_resources	local_gateway_route_tablevpc_associations_list_only	SELECT	region
get_resource	local_gateway_route_tablevpc_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual local_gateway_route_tablevpc_association.

SELECT
  region,
  local_gateway_id,
  local_gateway_route_table_id,
  local_gateway_route_table_vpc_association_id,
  state,
  vpc_id,
  tags
FROM awscc.ec2.local_gateway_route_tablevpc_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ local_gateway_route_table_vpc_association_id }}';

list (identifiers only)

Lists all local_gateway_route_tablevpc_associations in a region.

SELECT
  region,
  local_gateway_route_table_vpc_association_id
FROM awscc.ec2.local_gateway_route_tablevpc_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.local_gateway_route_tablevpc_associations (
  LocalGatewayRouteTableId,
  VpcId,
  region
)
SELECT
  '{{ local_gateway_route_table_id }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.local_gateway_route_tablevpc_associations (
  LocalGatewayRouteTableId,
  VpcId,
  Tags,
  region
)
SELECT
  '{{ local_gateway_route_table_id }}',
  '{{ vpc_id }}',
  '{{ tags }}',
  '{{ 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: local_gateway_route_tablevpc_association
  props:
    - name: local_gateway_route_table_id
      value: '{{ local_gateway_route_table_id }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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

Create

ec2:CreateLocalGatewayRouteTableVpcAssociation,
ec2:DescribeLocalGatewayRouteTableVpcAssociations,
ec2:CreateTags

Read

ec2:DescribeLocalGatewayRouteTableVpcAssociations,
ec2:DescribeTags

Update

ec2:DescribeLocalGatewayRouteTableVpcAssociations,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeTags

Delete

ec2:DeleteLocalGatewayRouteTableVpcAssociation,
ec2:DescribeLocalGatewayRouteTableVpcAssociations,
ec2:DeleteTags

List

ec2:DescribeLocalGatewayRouteTableVpcAssociations