Class VpnConnection
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.VpnConnection
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VpnConnection.Builder,VpnConnection>
@Generated("software.amazon.awssdk:codegen") public final class VpnConnection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpnConnection.Builder,VpnConnection>
Describes a VPN connection.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
VpnConnection.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VpnConnection.Builder
builder()
String
category()
The category of the VPN connection.String
coreNetworkArn()
The ARN of the core network.String
coreNetworkAttachmentArn()
The ARN of the core network attachment.String
customerGatewayConfiguration()
The configuration information for the VPN connection's customer gateway (in the native XML format).String
customerGatewayId()
The ID of the customer gateway at your end of the VPN connection.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
GatewayAssociationState
gatewayAssociationState()
The current state of the gateway association.String
gatewayAssociationStateAsString()
The current state of the gateway association.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasRoutes()
For responses, this returns true if the service returned a value for the Routes property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.boolean
hasVgwTelemetry()
For responses, this returns true if the service returned a value for the VgwTelemetry property.VpnConnectionOptions
options()
The VPN connection options.List<VpnStaticRoute>
routes()
The static routes associated with the VPN connection.List<SdkField<?>>
sdkFields()
static Class<? extends VpnConnection.Builder>
serializableBuilderClass()
VpnState
state()
The current state of the VPN connection.String
stateAsString()
The current state of the VPN connection.List<Tag>
tags()
Any tags assigned to the VPN connection.VpnConnection.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
transitGatewayId()
The ID of the transit gateway associated with the VPN connection.GatewayType
type()
The type of VPN connection.String
typeAsString()
The type of VPN connection.List<VgwTelemetry>
vgwTelemetry()
Information about the VPN tunnel.String
vpnConnectionId()
The ID of the VPN connection.String
vpnGatewayId()
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.-
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
-
customerGatewayConfiguration
public final String customerGatewayConfiguration()
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the
pending
oravailable
state.- Returns:
- The configuration information for the VPN connection's customer gateway (in the native XML format). This
element is always present in the CreateVpnConnection response; however, it's present in the
DescribeVpnConnections response only if the VPN connection is in the
pending
oravailable
state.
-
customerGatewayId
public final String customerGatewayId()
The ID of the customer gateway at your end of the VPN connection.
- Returns:
- The ID of the customer gateway at your end of the VPN connection.
-
category
public final String category()
The category of the VPN connection. A value of
VPN
indicates an Amazon Web Services VPN connection. A value ofVPN-Classic
indicates an Amazon Web Services Classic VPN connection.- Returns:
- The category of the VPN connection. A value of
VPN
indicates an Amazon Web Services VPN connection. A value ofVPN-Classic
indicates an Amazon Web Services Classic VPN connection.
-
state
public final VpnState state()
The current state of the VPN connection.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the VPN connection.
- See Also:
VpnState
-
stateAsString
public final String stateAsString()
The current state of the VPN connection.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the VPN connection.
- See Also:
VpnState
-
type
public final GatewayType type()
The type of VPN connection.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection.
- See Also:
GatewayType
-
typeAsString
public final String typeAsString()
The type of VPN connection.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection.
- See Also:
GatewayType
-
vpnConnectionId
public final String vpnConnectionId()
The ID of the VPN connection.
- Returns:
- The ID of the VPN connection.
-
vpnGatewayId
public final String vpnGatewayId()
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
- Returns:
- The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
-
transitGatewayId
public final String transitGatewayId()
The ID of the transit gateway associated with the VPN connection.
- Returns:
- The ID of the transit gateway associated with the VPN connection.
-
coreNetworkArn
public final String coreNetworkArn()
The ARN of the core network.
- Returns:
- The ARN of the core network.
-
coreNetworkAttachmentArn
public final String coreNetworkAttachmentArn()
The ARN of the core network attachment.
- Returns:
- The ARN of the core network attachment.
-
gatewayAssociationState
public final GatewayAssociationState gatewayAssociationState()
The current state of the gateway association.
If the service returns an enum value that is not available in the current SDK version,
gatewayAssociationState
will returnGatewayAssociationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgatewayAssociationStateAsString()
.- Returns:
- The current state of the gateway association.
- See Also:
GatewayAssociationState
-
gatewayAssociationStateAsString
public final String gatewayAssociationStateAsString()
The current state of the gateway association.
If the service returns an enum value that is not available in the current SDK version,
gatewayAssociationState
will returnGatewayAssociationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgatewayAssociationStateAsString()
.- Returns:
- The current state of the gateway association.
- See Also:
GatewayAssociationState
-
options
public final VpnConnectionOptions options()
The VPN connection options.
- Returns:
- The VPN connection options.
-
hasRoutes
public final boolean hasRoutes()
For responses, this returns true if the service returned a value for the Routes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
routes
public final List<VpnStaticRoute> routes()
The static routes associated with the VPN connection.
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
hasRoutes()
method.- Returns:
- The static routes associated with the VPN connection.
-
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 theisEmpty()
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 VPN connection.
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 VPN connection.
-
hasVgwTelemetry
public final boolean hasVgwTelemetry()
For responses, this returns true if the service returned a value for the VgwTelemetry property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
vgwTelemetry
public final List<VgwTelemetry> vgwTelemetry()
Information about the VPN tunnel.
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
hasVgwTelemetry()
method.- Returns:
- Information about the VPN tunnel.
-
toBuilder
public VpnConnection.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<VpnConnection.Builder,VpnConnection>
-
builder
public static VpnConnection.Builder builder()
-
serializableBuilderClass
public static Class<? extends VpnConnection.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-