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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of the Route Server Peer.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	route_server_peers	INSERT	RouteServerEndpointId, PeerAddress, BgpOptions, region
delete_resource	route_server_peers	DELETE	Identifier, region
update_resource	route_server_peers	UPDATE	Identifier, PatchDocument, region
list_resources	route_server_peers_list_only	SELECT	region
get_resource	route_server_peers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all route_server_peers in a region.

SELECT
  region,
  id
FROM awscc.ec2.route_server_peers_list_only
WHERE
  region = '{{ region }}';

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
  '{{ route_server_endpoint_id }}',
  '{{ peer_address }}',
  '{{ bgp_options }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.route_server_peers (
  RouteServerEndpointId,
  PeerAddress,
  BgpOptions,
  Tags,
  region
)
SELECT
  '{{ route_server_endpoint_id }}',
  '{{ peer_address }}',
  '{{ bgp_options }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: route_server_endpoint_id
      value: '{{ route_server_endpoint_id }}'
    - name: peer_address
      value: '{{ peer_address }}'
    - name: bgp_options
      value:
        peer_asn: '{{ peer_asn }}'
        peer_liveness_detection: '{{ peer_liveness_detection }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a route_server_peer resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.route_server_peers
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.route_server_peers
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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