@Generated(value="software.amazon.awssdk:codegen") public final class BGPPeer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BGPPeer.Builder,BGPPeer>
Information about a BGP peer.
Modifier and Type | Class and Description |
---|---|
static interface |
BGPPeer.Builder |
Modifier and Type | Method and Description |
---|---|
AddressFamily |
addressFamily()
The address family for the BGP peer.
|
String |
addressFamilyAsString()
The address family for the BGP peer.
|
String |
amazonAddress()
The IP address assigned to the Amazon interface.
|
Integer |
asn()
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
|
String |
authKey()
The authentication key for BGP configuration.
|
String |
awsDeviceV2()
The Direct Connect endpoint on which the BGP peer terminates.
|
String |
bgpPeerId()
The ID of the BGP peer.
|
BGPPeerState |
bgpPeerState()
The state of the BGP peer.
|
String |
bgpPeerStateAsString()
The state of the BGP peer.
|
BGPStatus |
bgpStatus()
The status of the BGP peer.
|
String |
bgpStatusAsString()
The status of the BGP peer.
|
static BGPPeer.Builder |
builder() |
String |
customerAddress()
The IP address assigned to the customer interface.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends BGPPeer.Builder> |
serializableBuilderClass() |
BGPPeer.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String bgpPeerId()
The ID of the BGP peer.
public final Integer asn()
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
public final String authKey()
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
public final AddressFamily addressFamily()
The address family for the BGP peer.
If the service returns an enum value that is not available in the current SDK version, addressFamily
will return AddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
addressFamilyAsString()
.
AddressFamily
public final String addressFamilyAsString()
The address family for the BGP peer.
If the service returns an enum value that is not available in the current SDK version, addressFamily
will return AddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
addressFamilyAsString()
.
AddressFamily
public final String amazonAddress()
The IP address assigned to the Amazon interface.
public final String customerAddress()
The IP address assigned to the customer interface.
public final BGPPeerState bgpPeerState()
The state of the BGP peer. The following are the possible values:
verifying
: The BGP peering addresses or ASN require validation before the BGP peer can be created.
This state applies only to public virtual interfaces.
pending
: The BGP peer is created, and remains in this state until it is ready to be established.
available
: The BGP peer is ready to be established.
deleting
: The BGP peer is being deleted.
deleted
: The BGP peer is deleted and cannot be established.
If the service returns an enum value that is not available in the current SDK version, bgpPeerState
will
return BGPPeerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
bgpPeerStateAsString()
.
verifying
: The BGP peering addresses or ASN require validation before the BGP peer can be
created. This state applies only to public virtual interfaces.
pending
: The BGP peer is created, and remains in this state until it is ready to be
established.
available
: The BGP peer is ready to be established.
deleting
: The BGP peer is being deleted.
deleted
: The BGP peer is deleted and cannot be established.
BGPPeerState
public final String bgpPeerStateAsString()
The state of the BGP peer. The following are the possible values:
verifying
: The BGP peering addresses or ASN require validation before the BGP peer can be created.
This state applies only to public virtual interfaces.
pending
: The BGP peer is created, and remains in this state until it is ready to be established.
available
: The BGP peer is ready to be established.
deleting
: The BGP peer is being deleted.
deleted
: The BGP peer is deleted and cannot be established.
If the service returns an enum value that is not available in the current SDK version, bgpPeerState
will
return BGPPeerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
bgpPeerStateAsString()
.
verifying
: The BGP peering addresses or ASN require validation before the BGP peer can be
created. This state applies only to public virtual interfaces.
pending
: The BGP peer is created, and remains in this state until it is ready to be
established.
available
: The BGP peer is ready to be established.
deleting
: The BGP peer is being deleted.
deleted
: The BGP peer is deleted and cannot be established.
BGPPeerState
public final BGPStatus bgpStatus()
The status of the BGP peer. The following are the possible values:
up
: The BGP peer is established. This state does not indicate the state of the routing function.
Ensure that you are receiving routes over the BGP session.
down
: The BGP peer is down.
unknown
: The BGP peer status is not available.
If the service returns an enum value that is not available in the current SDK version, bgpStatus
will
return BGPStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
bgpStatusAsString()
.
up
: The BGP peer is established. This state does not indicate the state of the routing
function. Ensure that you are receiving routes over the BGP session.
down
: The BGP peer is down.
unknown
: The BGP peer status is not available.
BGPStatus
public final String bgpStatusAsString()
The status of the BGP peer. The following are the possible values:
up
: The BGP peer is established. This state does not indicate the state of the routing function.
Ensure that you are receiving routes over the BGP session.
down
: The BGP peer is down.
unknown
: The BGP peer status is not available.
If the service returns an enum value that is not available in the current SDK version, bgpStatus
will
return BGPStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
bgpStatusAsString()
.
up
: The BGP peer is established. This state does not indicate the state of the routing
function. Ensure that you are receiving routes over the BGP session.
down
: The BGP peer is down.
unknown
: The BGP peer status is not available.
BGPStatus
public final String awsDeviceV2()
The Direct Connect endpoint on which the BGP peer terminates.
public BGPPeer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BGPPeer.Builder,BGPPeer>
public static BGPPeer.Builder builder()
public static Class<? extends BGPPeer.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.