route_server_endpoints

Creates, updates, deletes, gets or lists a route_server_endpoints resource.

Overview

Name	route_server_endpoints
Type	Resource
Id	aws.ec2.route_server_endpoints

Fields

The following fields are returned by SELECT queries:

describe_route_server_endpoints

Name	Datatype	Description
eni_address	string	The IP address of the Elastic network interface for the endpoint.
eni_id	string	The ID of the Elastic network interface for the endpoint.
failure_reason	string	The reason for any failure in endpoint creation or operation.
route_server_endpoint_id	string	The unique identifier of the route server endpoint.
route_server_id	string	The ID of the route server associated with this endpoint.
state	string	The current state of the route server endpoint.
subnet_id	string	The ID of the subnet to place the route server endpoint into.
tags	string	Any tags assigned to the route server endpoint.
vpc_id	string	The ID of the VPC containing the endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_route_server_endpoints	select	region	RouteServerEndpointId, NextToken, MaxResults, Filter, DryRun	Describes one or more route server endpoints. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
create_route_server_endpoint	insert	RouteServerId, SubnetId, region	ClientToken, DryRun, TagSpecification	Creates a new endpoint for a route server in a specified subnet. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
delete_route_server_endpoint	delete	RouteServerEndpointId, region	DryRun	Deletes the specified route server endpoint. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
RouteServerEndpointId	string	The ID of the route server endpoint to delete.
RouteServerId	string	The ID of the route server for which to create an endpoint.
SubnetId	string	The ID of the subnet in which to create the route server endpoint.
region	string	AWS region (default: us-east-1)
ClientToken	string	Unique, case-sensitive identifier to ensure idempotency of the request.
DryRun	boolean	A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters to apply to the describe request.
MaxResults	integer	The maximum number of results to return with a single call.
NextToken	string	The token for the next page of results.
RouteServerEndpointId	array	The IDs of the route server endpoints to describe.
TagSpecification	array	The tags to apply to the route server endpoint during creation.

SELECT examples

describe_route_server_endpoints

Describes one or more route server endpoints. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

SELECT
eni_address,
eni_id,
failure_reason,
route_server_endpoint_id,
route_server_id,
state,
subnet_id,
tags,
vpc_id
FROM aws.ec2.route_server_endpoints
WHERE region = '{{ region }}' -- required
AND RouteServerEndpointId = '{{ RouteServerEndpointId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_route_server_endpoint

Creates a new endpoint for a route server in a specified subnet. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

INSERT INTO aws.ec2.route_server_endpoints (
RouteServerId,
SubnetId,
region,
ClientToken,
DryRun,
TagSpecification
)
SELECT 
'{{ RouteServerId }}',
'{{ SubnetId }}',
'{{ region }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ TagSpecification }}'
RETURNING
eni_address,
eni_id,
failure_reason,
route_server_endpoint_id,
route_server_id,
state,
subnet_id,
tags,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: route_server_endpoints
props:
  - name: RouteServerId
    value: "{{ RouteServerId }}"
    description: Required parameter for the route_server_endpoints resource.
  - name: SubnetId
    value: "{{ SubnetId }}"
    description: Required parameter for the route_server_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the route_server_endpoints resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier to ensure idempotency of the request.
    description: Unique, case-sensitive identifier to ensure idempotency of the request.
  - name: DryRun
    value: {{ DryRun }}
    description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the route server endpoint during creation.
    description: The tags to apply to the route server endpoint during creation.

DELETE examples

delete_route_server_endpoint

Deletes the specified route server endpoint. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

DELETE FROM aws.ec2.route_server_endpoints
WHERE RouteServerEndpointId = '{{ RouteServerEndpointId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;