Package software.amazon.awssdk.services.directconnect.model

Class NewPrivateVirtualInterface

java.lang.Object

software.amazon.awssdk.services.directconnect.model.NewPrivateVirtualInterface

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NewPrivateVirtualInterface.Builder,NewPrivateVirtualInterface>

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

Information about a private virtual interface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NewPrivateVirtualInterface.Builder

Method Summary

Modifier and Type	Method	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.
static NewPrivateVirtualInterface.Builder	builder()
String	customerAddress()	The IP address assigned to the customer interface.
String	directConnectGatewayId()	The ID of the Direct Connect gateway.
Boolean	enableSiteLink()	Indicates whether to enable or disable SiteLink.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
Integer	mtu()	The maximum transmission unit (MTU), in bytes.
List<SdkField<?>>	sdkFields()
static Class<? extends NewPrivateVirtualInterface.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags associated with the private virtual interface.
NewPrivateVirtualInterface.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	virtualGatewayId()	The ID of the virtual private gateway.
String	virtualInterfaceName()	The name of the virtual interface assigned by the customer network.
Integer	vlan()	The ID of the VLAN.

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

virtualInterfaceName

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 (-).

Returns:

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 (-).

vlan

public final Integer vlan()

The ID of the VLAN.

Returns:

The ID of the VLAN.

asn

public final Integer asn()

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

Returns:

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

mtu

public final 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.

authKey

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.

Returns:

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

amazonAddress

public final String amazonAddress()

The IP address assigned to the Amazon interface.

Returns:

The IP address assigned to the Amazon interface.

customerAddress

public final String customerAddress()

The IP address assigned to the customer interface.

Returns:

The IP address assigned to the customer interface.

addressFamily

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().

Returns:

The address family for the BGP peer.

See Also:

AddressFamily

addressFamilyAsString

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().

Returns:

The address family for the BGP peer.

See Also:

AddressFamily

virtualGatewayId

public final String virtualGatewayId()

The ID of the virtual private gateway.

Returns:

The ID of the virtual private gateway.

directConnectGatewayId

public final String directConnectGatewayId()

The ID of the Direct Connect gateway.

Returns:

The ID of the Direct Connect gateway.

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()

The tags associated with the private 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.

Returns:

The tags associated with the private virtual interface.

enableSiteLink

public final Boolean enableSiteLink()

Indicates whether to enable or disable SiteLink.

Returns:

Indicates whether to enable or disable SiteLink.

toBuilder

public NewPrivateVirtualInterface.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NewPrivateVirtualInterface.Builder,NewPrivateVirtualInterface>

builder

public static NewPrivateVirtualInterface.Builder builder()

serializableBuilderClass

public static Class<? extends NewPrivateVirtualInterface.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