route_server_peers

Creates, updates, deletes or gets a route_server_peer resource or lists route_server_peers in a region

Overview

Name	route_server_peers
Type	Resource
Description	VPC Route Server Peer
Id	awscc.ec2.route_server_peers

Fields

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

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RouteServerEndpointId, PeerAddress, BgpOptions, 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_peer.

SELECT
region,
route_server_id,
route_server_endpoint_id,
arn,
id,
subnet_id,
vpc_id,
endpoint_eni_id,
endpoint_eni_address,
peer_address,
bgp_options,
tags
FROM awscc.ec2.route_server_peers
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_peer resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.route_server_peers (
 RouteServerEndpointId,
 PeerAddress,
 BgpOptions,
 region
)
SELECT 
'{{ RouteServerEndpointId }}',
 '{{ PeerAddress }}',
 '{{ BgpOptions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.route_server_peers (
 RouteServerEndpointId,
 PeerAddress,
 BgpOptions,
 Tags,
 region
)
SELECT 
 '{{ RouteServerEndpointId }}',
 '{{ PeerAddress }}',
 '{{ BgpOptions }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: route_server_peer
    props:
      - name: RouteServerEndpointId
        value: '{{ RouteServerEndpointId }}'
      - name: PeerAddress
        value: '{{ PeerAddress }}'
      - name: BgpOptions
        value:
          PeerAsn: '{{ PeerAsn }}'
          PeerLivenessDetection: '{{ PeerLivenessDetection }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ec2:CreateRouteServerPeer,
ec2:CreateTags,
ec2:DescribeRouteServerPeers,
ec2:AuthorizeSecurityGroupIngress

Read

ec2:DescribeRouteServerPeers,
ec2:DescribeTags

Update

ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeRouteServerPeers,
ec2:DescribeTags,
ec2:ModifyRouteServerPeer

Delete

ec2:DescribeTags,
ec2:DescribeRouteServerPeers,
ec2:DeleteRouteServerPeer,
ec2:DeleteTags,
ec2:RevokeSecurityGroupIngress

List

ec2:DescribeTags,
ec2:DescribeRouteServerPeers