java.lang.Object
- software.amazon.awssdk.services.ec2.model.RouteServerPeer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RouteServerPeer.Builder,RouteServerPeer>
```
@Generated("software.amazon.awssdk:codegen")
public final class RouteServerPeer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteServerPeer.Builder,RouteServerPeer>
```
Describes 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 Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
- Have an elastic network interface in the VPC
- Support BGP (Border Gateway Protocol)
- Can initiate BGP sessions
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RouteServerPeer.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RouteServerBfdStatus`	`bfdStatus()`	The current status of the BFD session with this peer.
`RouteServerBgpOptions`	`bgpOptions()`	The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
`RouteServerBgpStatus`	`bgpStatus()`	The current status of the BGP session with this peer.
`static RouteServerPeer.Builder`	`builder()`
`String`	`endpointEniAddress()`	The IP address of the Elastic network interface for the route server endpoint.
`String`	`endpointEniId()`	The ID of the Elastic network interface for the route server endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	The reason for any failure in peer creation or operation.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`peerAddress()`	The IPv4 address of the peer device.
`String`	`routeServerEndpointId()`	The ID of the route server endpoint associated with this peer.
`String`	`routeServerId()`	The ID of the route server associated with this peer.
`String`	`routeServerPeerId()`	The unique identifier of the route server peer.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RouteServerPeer.Builder>`	`serializableBuilderClass()`
`RouteServerPeerState`	`state()`	The current state of the route server peer.
`String`	`stateAsString()`	The current state of the route server peer.
`String`	`subnetId()`	The ID of the subnet containing the route server peer.
`List<Tag>`	`tags()`	Any tags assigned to the route server peer.
`RouteServerPeer.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vpcId()`	The ID of the VPC containing the route server peer.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - routeServerPeerId
```
public final String routeServerPeerId()
```
    The unique identifier of the route server peer.
    
    Returns:
    
    The unique identifier of the route server peer.
  - routeServerEndpointId
```
public final String routeServerEndpointId()
```
    The ID of the route server endpoint associated with this peer.
    
    Returns:
    
    The ID of the route server endpoint associated with this peer.
  - routeServerId
```
public final String routeServerId()
```
    The ID of the route server associated with this peer.
    
    Returns:
    
    The ID of the route server associated with this peer.
  - vpcId
```
public final String vpcId()
```
    The ID of the VPC containing the route server peer.
    
    Returns:
    
    The ID of the VPC containing the route server peer.
  - subnetId
```
public final String subnetId()
```
    The ID of the subnet containing the route server peer.
    
    Returns:
    
    The ID of the subnet containing the route server peer.
  - state
```
public final RouteServerPeerState state()
```
    The current state of the route server peer.
    
    If the service returns an enum value that is not available in the current SDK version, state will return RouteServerPeerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the route server peer.
    
    See Also:
    
    RouteServerPeerState
  - stateAsString
```
public final String stateAsString()
```
    The current state of the route server peer.
    
    If the service returns an enum value that is not available in the current SDK version, state will return RouteServerPeerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the route server peer.
    
    See Also:
    
    RouteServerPeerState
  - failureReason
```
public final String failureReason()
```
    The reason for any failure in peer creation or operation.
    
    Returns:
    
    The reason for any failure in peer creation or operation.
  - endpointEniId
```
public final String endpointEniId()
```
    The ID of the Elastic network interface for the route server endpoint.
    
    Returns:
    
    The ID of the Elastic network interface for the route server endpoint.
  - endpointEniAddress
```
public final String endpointEniAddress()
```
    The IP address of the Elastic network interface for the route server endpoint.
    
    Returns:
    
    The IP address of the Elastic network interface for the route server endpoint.
  - peerAddress
```
public final String peerAddress()
```
    The IPv4 address of the peer device.
    
    Returns:
    
    The IPv4 address of the peer device.
  - bgpOptions
```
public final RouteServerBgpOptions bgpOptions()
```
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    
    Returns:
    
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
  - bgpStatus
```
public final RouteServerBgpStatus bgpStatus()
```
    The current status of the BGP session with this peer.
    
    Returns:
    
    The current status of the BGP session with this peer.
  - bfdStatus
```
public final RouteServerBfdStatus bfdStatus()
```
    The current status of the BFD session with this peer.
    
    Returns:
    
    The current status of the BFD session with this peer.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Any tags assigned to the route server peer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Any tags assigned to the route server peer.
  - toBuilder
```
public RouteServerPeer.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RouteServerPeer.Builder,RouteServerPeer>
  - builder
```
public static RouteServerPeer.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RouteServerPeer.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class RouteServerPeer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

routeServerPeerId

routeServerEndpointId

routeServerId

vpcId

subnetId

state

stateAsString

failureReason

endpointEniId

endpointEniAddress

peerAddress

bgpOptions

bgpStatus

bfdStatus

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField