route_servers

Creates, updates, deletes or gets a route_server resource or lists route_servers in a region

Overview

Name	route_servers
Type	Resource
Description	VPC Route Server
Id	awscc.ec2.route_servers

Fields

Name	Datatype	Description
amazon_side_asn	integer	The Amazon-side ASN of the Route Server.
arn	string	The Amazon Resource Name (ARN) of the Route Server.
id	string	The ID of the Route Server.
persist_routes	string	Whether to enable persistent routes
persist_routes_duration	integer	The duration of persistent routes in minutes
sns_notifications_enabled	boolean	Whether to enable SNS notifications
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AmazonSideAsn, 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.

SELECT
region,
amazon_side_asn,
arn,
id,
persist_routes,
persist_routes_duration,
sns_notifications_enabled,
tags
FROM awscc.ec2.route_servers
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 resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.route_servers (
 AmazonSideAsn,
 region
)
SELECT 
'{{ AmazonSideAsn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.route_servers (
 AmazonSideAsn,
 PersistRoutes,
 PersistRoutesDuration,
 SnsNotificationsEnabled,
 Tags,
 region
)
SELECT 
 '{{ AmazonSideAsn }}',
 '{{ PersistRoutes }}',
 '{{ PersistRoutesDuration }}',
 '{{ SnsNotificationsEnabled }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: route_server
    props:
      - name: AmazonSideAsn
        value: '{{ AmazonSideAsn }}'
      - name: PersistRoutes
        value: '{{ PersistRoutes }}'
      - name: PersistRoutesDuration
        value: '{{ PersistRoutesDuration }}'
      - name: SnsNotificationsEnabled
        value: '{{ SnsNotificationsEnabled }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ec2:CreateRouteServer,
ec2:CreateTags,
ec2:DescribeRouteServers,
sns:CreateTopic

Read

ec2:DescribeRouteServers,
ec2:DescribeTags

Update

ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeRouteServers,
ec2:DescribeTags,
ec2:ModifyRouteServer,
sns:CreateTopic,
sns:DeleteTopic

Delete

ec2:DescribeTags,
ec2:DescribeRouteServers,
ec2:DeleteRouteServer,
ec2:DeleteTags,
sns:DeleteTopic

List

ec2:DescribeTags,
ec2:DescribeRouteServers