@Generated(value="software.amazon.awssdk:codegen") public final class CreatePrivateVirtualInterfaceResponse extends DirectConnectResponse implements ToCopyableBuilder<CreatePrivateVirtualInterfaceResponse.Builder,CreatePrivateVirtualInterfaceResponse>
Information about a virtual interface.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreatePrivateVirtualInterfaceResponse.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.
|
Long |
amazonSideAsn()
The autonomous system number (ASN) for the Amazon side of the connection.
|
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 that terminates the physical connection.
|
String |
awsLogicalDeviceId()
The Direct Connect endpoint that terminates the logical connection.
|
List<BGPPeer> |
bgpPeers()
The BGP peers configured on this virtual interface.
|
static CreatePrivateVirtualInterfaceResponse.Builder |
builder() |
String |
connectionId()
The ID of the connection.
|
String |
customerAddress()
The IP address assigned to the customer interface.
|
String |
customerRouterConfig()
The customer router configuration.
|
String |
directConnectGatewayId()
The ID of the Direct Connect gateway.
|
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)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
boolean |
hasBgpPeers()
For responses, this returns true if the service returned a value for the BgpPeers property.
|
int |
hashCode() |
boolean |
hasRouteFilterPrefixes()
For responses, this returns true if the service returned a value for the RouteFilterPrefixes property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Boolean |
jumboFrameCapable()
Indicates whether jumbo frames (9001 MTU) are supported.
|
String |
location()
The location of the connection.
|
Integer |
mtu()
The maximum transmission unit (MTU), in bytes.
|
String |
ownerAccount()
The ID of the Amazon Web Services account that owns the virtual interface.
|
String |
region()
The Amazon Web Services Region where the virtual interface is located.
|
List<RouteFilterPrefix> |
routeFilterPrefixes()
The routes to be advertised to the Amazon Web Services network in this Region.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreatePrivateVirtualInterfaceResponse.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The tags associated with the virtual interface.
|
CreatePrivateVirtualInterfaceResponse.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.
|
String |
virtualGatewayId()
The ID of the virtual private gateway.
|
String |
virtualInterfaceId()
The ID of the virtual interface.
|
String |
virtualInterfaceName()
The name of the virtual interface assigned by the customer network.
|
VirtualInterfaceState |
virtualInterfaceState()
The state of the virtual interface.
|
String |
virtualInterfaceStateAsString()
The state of the virtual interface.
|
String |
virtualInterfaceType()
The type of virtual interface.
|
Integer |
vlan()
The ID of the VLAN.
|
responseMetadatasdkHttpResponsecopypublic final String ownerAccount()
The ID of the Amazon Web Services account that owns the virtual interface.
public final String virtualInterfaceId()
The ID of the virtual interface.
public final String location()
The location of the connection.
public final String connectionId()
The ID of the connection.
public final String virtualInterfaceType()
The type of virtual interface. The possible values are private and public.
private and public.public final String virtualInterfaceName()
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
public final Integer vlan()
The ID of the VLAN.
public final Integer asn()
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
The valid values are 1-2147483647.
public final Long amazonSideAsn()
The autonomous system number (ASN) for the Amazon side of the connection.
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 String amazonAddress()
The IP address assigned to the Amazon interface.
public final String customerAddress()
The IP address assigned to the customer interface.
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().
AddressFamilypublic 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().
AddressFamilypublic final VirtualInterfaceState virtualInterfaceState()
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface
owner. If the owner of the virtual interface is different from the owner of the connection on which it is
provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual
interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling
DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
enters the Rejected state.
unknown: The state of the virtual interface is not available.
If the service returns an enum value that is not available in the current SDK version,
virtualInterfaceState will return VirtualInterfaceState.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from virtualInterfaceStateAsString().
confirming: The creation of the virtual interface is pending confirmation from the virtual
interface owner. If the owner of the virtual interface is different from the owner of the connection on
which it is provisioned, then the virtual interface will remain in this state until it is confirmed by
the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual
interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the
virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling
DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a
virtual interface in the Confirming state is deleted by the virtual interface owner, the
virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
VirtualInterfaceStatepublic final String virtualInterfaceStateAsString()
The state of the virtual interface. The following are the possible values:
confirming: The creation of the virtual interface is pending confirmation from the virtual interface
owner. If the owner of the virtual interface is different from the owner of the connection on which it is
provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual
interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling
DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
enters the Rejected state.
unknown: The state of the virtual interface is not available.
If the service returns an enum value that is not available in the current SDK version,
virtualInterfaceState will return VirtualInterfaceState.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from virtualInterfaceStateAsString().
confirming: The creation of the virtual interface is pending confirmation from the virtual
interface owner. If the owner of the virtual interface is different from the owner of the connection on
which it is provisioned, then the virtual interface will remain in this state until it is confirmed by
the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual
interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the
virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling
DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a
virtual interface in the Confirming state is deleted by the virtual interface owner, the
virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.
VirtualInterfaceStatepublic final String customerRouterConfig()
The customer router configuration.
public final Integer mtu()
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
public final Boolean jumboFrameCapable()
Indicates whether jumbo frames (9001 MTU) are supported.
public final String virtualGatewayId()
The ID of the virtual private gateway. Applies only to private virtual interfaces.
public final String directConnectGatewayId()
The ID of the Direct Connect gateway.
public final boolean hasRouteFilterPrefixes()
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.public final List<RouteFilterPrefix> routeFilterPrefixes()
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
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 hasRouteFilterPrefixes() method.
public final boolean hasBgpPeers()
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.public final List<BGPPeer> bgpPeers()
The BGP peers configured on this virtual interface.
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 hasBgpPeers() method.
public final String region()
The Amazon Web Services Region where the virtual interface is located.
public final String awsDeviceV2()
The Direct Connect endpoint that terminates the physical connection.
public final String awsLogicalDeviceId()
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
public final boolean hasTags()
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.public final List<Tag> tags()
The tags associated with the virtual interface.
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.
public CreatePrivateVirtualInterfaceResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreatePrivateVirtualInterfaceResponse.Builder,CreatePrivateVirtualInterfaceResponse>toBuilder in class AwsResponsepublic static CreatePrivateVirtualInterfaceResponse.Builder builder()
public static Class<? extends CreatePrivateVirtualInterfaceResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will
again be available.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.