route_server_associations
Creates, updates, deletes, gets or lists a route_server_associations resource.
Overview
| Name | route_server_associations |
| Type | Resource |
| Id | aws.ec2.route_server_associations |
Fields
The following fields are returned by SELECT queries:
- get_route_server_associations
| Name | Datatype | Description |
|---|---|---|
route_server_id | string | The ID of the associated route server. |
state | string | The current state of the association. |
vpc_id | string | The ID of the associated VPC. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_route_server_associations | select | RouteServerId, region | DryRun | Gets information about the associations for the specified route server. 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. |
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 |
|---|---|---|
RouteServerId | string | The ID of the route server for which to get association information. |
region | string | AWS region (default: us-east-1) |
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. |
SELECT examples
- get_route_server_associations
Gets information about the associations for the specified route server. 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.
SELECT
route_server_id,
state,
vpc_id
FROM aws.ec2.route_server_associations
WHERE RouteServerId = '{{ RouteServerId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;