This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).
# AWS::EC2::RouteServerPeer

Specifies a BGP peer configuration for a route server endpoint.
A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).
## Syntax

To declare this entity in your CloudFormation template, use the following syntax:
### JSON

```
{
 "Type" : "AWS::EC2::RouteServerPeer",
 "Properties" : {
 "[BgpOptions](#cfn-ec2-routeserverpeer-bgpoptions)" : {{BgpOptions}},
 "[PeerAddress](#cfn-ec2-routeserverpeer-peeraddress)" : {{String}},
 "[RouteServerEndpointId](#cfn-ec2-routeserverpeer-routeserverendpointid)" : {{String}},
 "[Tags](#cfn-ec2-routeserverpeer-tags)" : {{[ Tag, ... ]}}
 }
}
```
### YAML

```
Type: AWS::EC2::RouteServerPeer
Properties:
 [BgpOptions](#cfn-ec2-routeserverpeer-bgpoptions): {{
 BgpOptions}}
 [PeerAddress](#cfn-ec2-routeserverpeer-peeraddress): {{String}}
 [RouteServerEndpointId](#cfn-ec2-routeserverpeer-routeserverendpointid): {{String}}
 [Tags](#cfn-ec2-routeserverpeer-tags): {{
 - Tag}}
```
## Properties

`BgpOptions` 
The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. 
*Required*: Yes 
*Type*: [BgpOptions](aws-properties-ec2-routeserverpeer-bgpoptions.md) 
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`PeerAddress` 
The IPv4 address of the peer device. 
*Required*: Yes 
*Type*: String 
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`RouteServerEndpointId` 
The ID of the route server endpoint associated with this peer. 
*Required*: Yes 
*Type*: String 
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`Tags` 
Any tags assigned to the route server peer. 
*Required*: No 
*Type*: Array of [Tag](aws-properties-ec2-routeserverpeer-tag.md) 
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
## Return values

### Ref

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the peer ID.
### Fn::GetAtt

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).
#### 

`Arn` 
The ARN of the route server peer.
`EndpointEniAddress` 
The IP address of the Elastic network interface for the route server endpoint.
`EndpointEniId` 
The ID of the Elastic network interface for the route server endpoint.
`Id` 
The ID of the route server peer.
`RouteServerId` 
The ID of the route server associated with this peer.
`SubnetId` 
The ID of the subnet containing the route server peer.
`VpcId` 
The ID of the VPC containing the route server peer.</div><div class="naked_ctrl">
<form action="/index.cgi/contrast" method="get" name="gate">
<p><a href="http://altstyle.alfasado.net">AltStyle</a> によって変換されたページ <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-routeserverpeer.md">(-&gt;オリジナル)</a>
/ <label>アドレス: <input type="text" name="naked_post_url" value="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-routeserverpeer.md" size="22" /></label> <label>モード: <select name="naked_post_mode">
<option value="default">デフォルト</option>
<option value="speech">音声ブラウザ</option>
<option value="ruby">ルビ付き</option>
<option value="contrast" selected="selected">配色反転</option>
<option value="larger-text">文字拡大</option>
<option value="mobile">モバイル</option>
</select>
<input type="submit" value="表示" />
</p>
</form>
</div>