VirtualInterface (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.directconnect.model.VirtualInterface

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<VirtualInterface.Builder,VirtualInterface>

@Generated(value="software.amazon.awssdk:codegen")
public final class VirtualInterface
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VirtualInterface.Builder,VirtualInterface>

Information about a virtual interface.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface VirtualInterface.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`VirtualInterface.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 on which the virtual interface terminates.
`List<BGPPeer>`	`bgpPeers()` The BGP peers configured on this virtual interface.
`static VirtualInterface.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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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 AWS account that owns the virtual interface.
`String`	`region()` The AWS Region where the virtual interface is located.
`List<RouteFilterPrefix>`	`routeFilterPrefixes()` The routes to be advertised to the AWS network in this Region.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VirtualInterface.Builder>`	`serializableBuilderClass()`
`VirtualInterface.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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.

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

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

- Method Detail
  - ownerAccount
```
public String ownerAccount()
```
    The ID of the AWS account that owns the virtual interface.
    
    Returns:
    
    The ID of the AWS account that owns the virtual interface.
  - virtualInterfaceId
```
public String virtualInterfaceId()
```
    The ID of the virtual interface.
    
    Returns:
    
    The ID of the virtual interface.
  - location
```
public String location()
```
    The location of the connection.
    
    Returns:
    
    The location of the connection.
  - connectionId
```
public String connectionId()
```
    The ID of the connection.
    
    Returns:
    
    The ID of the connection.
  - virtualInterfaceType
```
public String virtualInterfaceType()
```
    The type of virtual interface. The possible values are private and public.
    
    Returns:
    
    The type of virtual interface. The possible values are private and public.
  - virtualInterfaceName
```
public String virtualInterfaceName()
```
    The name of the virtual interface assigned by the customer network.
    
    Returns:
    
    The name of the virtual interface assigned by the customer network.
  - vlan
```
public Integer vlan()
```
    The ID of the VLAN.
    
    Returns:
    
    The ID of the VLAN.
  - asn
```
public Integer asn()
```
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    
    Returns:
    
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  - amazonSideAsn
```
public Long amazonSideAsn()
```
    The autonomous system number (ASN) for the Amazon side of the connection.
    
    Returns:
    
    The autonomous system number (ASN) for the Amazon side of the connection.
  - authKey
```
public String authKey()
```
    The authentication key for BGP configuration.
    
    Returns:
    
    The authentication key for BGP configuration.
  - amazonAddress
```
public String amazonAddress()
```
    The IP address assigned to the Amazon interface.
    
    Returns:
    
    The IP address assigned to the Amazon interface.
  - customerAddress
```
public String customerAddress()
```
    The IP address assigned to the customer interface.
    
    Returns:
    
    The IP address assigned to the customer interface.
  - addressFamily
```
public 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().
    
    Returns:
    
    The address family for the BGP peer.
    
    See Also:
    
    AddressFamily
  - addressFamilyAsString
```
public 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().
    
    Returns:
    
    The address family for the BGP peer.
    
    See Also:
    
    AddressFamily
  - virtualInterfaceState
```
public 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.
    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().
    Returns:
    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.
    See Also:
    
    VirtualInterfaceState
  - virtualInterfaceStateAsString
```
public 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.
    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().
    Returns:
    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.
    See Also:
    
    VirtualInterfaceState
  - customerRouterConfig
```
public String customerRouterConfig()
```
    The customer router configuration.
    
    Returns:
    
    The customer router configuration.
  - mtu
```
public Integer mtu()
```
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    
    Returns:
    
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
  - jumboFrameCapable
```
public Boolean jumboFrameCapable()
```
    Indicates whether jumbo frames (9001 MTU) are supported.
    
    Returns:
    
    Indicates whether jumbo frames (9001 MTU) are supported.
  - virtualGatewayId
```
public String virtualGatewayId()
```
    The ID of the virtual private gateway. Applies only to private virtual interfaces.
    
    Returns:
    
    The ID of the virtual private gateway. Applies only to private virtual interfaces.
  - directConnectGatewayId
```
public String directConnectGatewayId()
```
    The ID of the Direct Connect gateway.
    
    Returns:
    
    The ID of the Direct Connect gateway.
  - routeFilterPrefixes
```
public List<RouteFilterPrefix> routeFilterPrefixes()
```
    The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
  - bgpPeers
```
public 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.
    
    Returns:
    
    The BGP peers configured on this virtual interface.
  - region
```
public String region()
```
    The AWS Region where the virtual interface is located.
    
    Returns:
    
    The AWS Region where the virtual interface is located.
  - awsDeviceV2
```
public String awsDeviceV2()
```
    The Direct Connect endpoint on which the virtual interface terminates.
    
    Returns:
    
    The Direct Connect endpoint on which the virtual interface terminates.
  - toBuilder
```
public VirtualInterface.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VirtualInterface.Builder,VirtualInterface>
    
    Returns:
    
    a builder for type T
  - builder
```
public static VirtualInterface.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VirtualInterface.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class VirtualInterface

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

ownerAccount

virtualInterfaceId

location

connectionId

virtualInterfaceType

virtualInterfaceName

vlan

asn

amazonSideAsn

authKey

amazonAddress

customerAddress

addressFamily

addressFamilyAsString

virtualInterfaceState

virtualInterfaceStateAsString

customerRouterConfig

mtu

jumboFrameCapable

virtualGatewayId

directConnectGatewayId

routeFilterPrefixes

bgpPeers

region

awsDeviceV2

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields