route_server_endpoints

Creates, updates, deletes or gets a route_server_endpoint resource or lists route_server_endpoints in a region

Overview

Name	route_server_endpoints
Type	Resource
Description	VPC Route Server Endpoint
Id	awscc.ec2.route_server_endpoints

Fields

Name	Datatype	Description
route_server_id	string	Route Server ID
arn	string	The Amazon Resource Name (ARN) of the Route Server Endpoint.
id	string	The ID of the Route Server Endpoint.
subnet_id	string	Subnet ID
vpc_id	string	VPC ID
eni_id	string	Elastic Network Interface ID owned by the Route Server Endpoint
eni_address	string	Elastic Network Interface IP address owned by the Route Server Endpoint
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RouteServerId, SubnetId, 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 properties from an individual route_server_endpoint.

SELECT
region,
route_server_id,
arn,
id,
subnet_id,
vpc_id,
eni_id,
eni_address,
tags
FROM awscc.ec2.route_server_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.route_server_endpoints (
 RouteServerId,
 SubnetId,
 region
)
SELECT 
'{{ RouteServerId }}',
 '{{ SubnetId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.route_server_endpoints (
 RouteServerId,
 SubnetId,
 Tags,
 region
)
SELECT 
 '{{ RouteServerId }}',
 '{{ SubnetId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: route_server_endpoint
    props:
      - name: RouteServerId
        value: '{{ RouteServerId }}'
      - name: SubnetId
        value: '{{ SubnetId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.route_server_endpoints
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateRouteServerEndpoint,
ec2:CreateTags,
ec2:DescribeRouteServerEndpoints,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:CreateSecurityGroup,
ec2:DescribeSecurityGroups,
ec2:AuthorizeSecurityGroupIngress

Read

ec2:DescribeRouteServerEndpoints,
ec2:DescribeTags

Update

ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeRouteServerEndpoints,
ec2:DescribeTags,
ec2:ModifyRouteServerEndpoint

Delete

ec2:DescribeTags,
ec2:DescribeRouteServerEndpoints,
ec2:DeleteRouteServerEndpoint,
ec2:DeleteTags,
ec2:DeleteNetworkInterface,
ec2:DeleteSecurityGroup,
ec2:DescribeSecurityGroups,
ec2:RevokeSecurityGroupIngress

List

ec2:DescribeTags,
ec2:DescribeRouteServerEndpoints