route_servers

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

Overview

Name	`route_servers`
Type	Resource
Id	`aws.ec2.route_servers`

Fields

The following fields are returned by SELECT queries:

describe_route_servers

Name	Datatype	Description
`amazon_side_asn`	`integer`	The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
`persist_routes_duration`	`integer`	The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
`persist_routes_state`	`string`	The current state of route persistence for the route server.
`route_server_id`	`string`	The unique identifier of the route server.
`sns_notifications_enabled`	`boolean`	Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
`sns_topic_arn`	`string`	The ARN of the SNS topic where notifications are published.
`state`	`string`	The current state of the route server.
`tags`	`string`	Any tags assigned to the route server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_route_servers`	`select`	`region`	`RouteServerId`, `NextToken`, `MaxResults`, `Filter`, `DryRun`	Describes one or more route servers. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`create_route_server`	`insert`	`AmazonSideAsn`, `region`	`ClientToken`, `DryRun`, `PersistRoutes`, `PersistRoutesDuration`, `SnsNotificationsEnabled`, `TagSpecification`	Creates a new route server to manage dynamic routing in a VPC. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`associate_route_server`	`update`	`RouteServerId`, `VpcId`, `region`	`DryRun`	Associates a route server with a VPC to enable dynamic route updates. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`modify_route_server`	`update`	`RouteServerId`, `region`	`PersistRoutes`, `PersistRoutesDuration`, `SnsNotificationsEnabled`, `DryRun`	Modifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`delete_route_server`	`delete`	`RouteServerId`, `region`	`DryRun`	Deletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`disable_route_server_propagation`	`exec`	`RouteServerId`, `RouteTableId`, `region`	`DryRun`	Disables route propagation from a route server to a specified route table. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`disassociate_route_server`	`exec`	`RouteServerId`, `VpcId`, `region`	`DryRun`	Disassociates a route server from a VPC. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
`enable_route_server_propagation`	`exec`	`RouteServerId`, `RouteTableId`, `region`	`DryRun`	Defines which route tables the route server can update with routes. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

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
`AmazonSideAsn`	`integer (int64)`	The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
`RouteServerId`	`string`	The ID of the route server for which to enable propagation.
`RouteTableId`	`string`	The ID of the route table to which route server will propagate routes.
`VpcId`	`string`	The ID of the VPC to disassociate from the route server.
`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.
`PersistRoutes`	`string`	Specifies whether to persist routes after all BGP sessions are terminated. enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated. disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated. reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.
`PersistRoutesDuration`	`integer (int64)`	The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
`RouteServerId`	`array`	The IDs of the route servers to describe.
`SnsNotificationsEnabled`	`boolean`	Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
`TagSpecification`	`array`	The tags to apply to the route server during creation.

`SELECT` examples

describe_route_servers

Describes one or more route servers. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

SELECT
amazon_side_asn,
persist_routes_duration,
persist_routes_state,
route_server_id,
sns_notifications_enabled,
sns_topic_arn,
state,
tags
FROM aws.ec2.route_servers
WHERE region = '{{ region }}' -- required
AND RouteServerId = '{{ RouteServerId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

`INSERT` examples

create_route_server
Manifest

Creates a new route server to manage dynamic routing in a VPC. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

INSERT INTO aws.ec2.route_servers (
AmazonSideAsn,
region,
ClientToken,
DryRun,
PersistRoutes,
PersistRoutesDuration,
SnsNotificationsEnabled,
TagSpecification
)
SELECT 
'{{ AmazonSideAsn }}',
'{{ region }}',
'{{ ClientToken }}',
'{{ DryRun }}',
'{{ PersistRoutes }}',
'{{ PersistRoutesDuration }}',
'{{ SnsNotificationsEnabled }}',
'{{ TagSpecification }}'
RETURNING
amazon_side_asn,
persist_routes_duration,
persist_routes_state,
route_server_id,
sns_notifications_enabled,
sns_topic_arn,
state,
tags
;

# Description fields are for documentation purposes
- name: route_servers
props:
  - name: AmazonSideAsn
    value: "{{ AmazonSideAsn }}"
    description: Required parameter for the route_servers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the route_servers 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: PersistRoutes
    value: "{{ PersistRoutes }}"
    description: Indicates whether routes should be persisted after all BGP sessions are terminated.
    description: Indicates whether routes should be persisted after all BGP sessions are terminated.
  - name: PersistRoutesDuration
    value: "{{ PersistRoutesDuration }}"
    description: The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
    description: The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is enabled. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.
  - name: SnsNotificationsEnabled
    value: {{ SnsNotificationsEnabled }}
    description: Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
    description: Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the route server during creation.
    description: The tags to apply to the route server during creation.

`UPDATE` examples

associate_route_server
modify_route_server

Associates a route server with a VPC to enable dynamic route updates. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

UPDATE aws.ec2.route_servers
SET 
-- No updatable properties
WHERE 
RouteServerId = '{{ RouteServerId }}' --required
AND VpcId = '{{ VpcId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
route_server_id,
state,
vpc_id;

Modifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

UPDATE aws.ec2.route_servers
SET 
-- No updatable properties
WHERE 
RouteServerId = '{{ RouteServerId }}' --required
AND region = '{{ region }}' --required
AND PersistRoutes = '{{ PersistRoutes}}'
AND PersistRoutesDuration = '{{ PersistRoutesDuration}}'
AND SnsNotificationsEnabled = {{ SnsNotificationsEnabled}}
AND DryRun = {{ DryRun}}
RETURNING
amazon_side_asn,
persist_routes_duration,
persist_routes_state,
route_server_id,
sns_notifications_enabled,
sns_topic_arn,
state,
tags;

`DELETE` examples

delete_route_server

Deletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

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

Lifecycle Methods

disable_route_server_propagation
disassociate_route_server
enable_route_server_propagation

Disables route propagation from a route server to a specified route table. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: VPC route tables not associated with subnets Subnet route tables Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

EXEC aws.ec2.route_servers.disable_route_server_propagation 
@RouteServerId='{{ RouteServerId }}' --required, 
@RouteTableId='{{ RouteTableId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

Disassociates a route server from a VPC. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

EXEC aws.ec2.route_servers.disassociate_route_server 
@RouteServerId='{{ RouteServerId }}' --required, 
@VpcId='{{ VpcId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

Defines which route tables the route server can update with routes. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

EXEC aws.ec2.route_servers.enable_route_server_propagation 
@RouteServerId='{{ RouteServerId }}' --required, 
@RouteTableId='{{ RouteTableId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​