Package software.amazon.awssdk.services.ec2.model

Class VpnGateway

java.lang.Object

software.amazon.awssdk.services.ec2.model.VpnGateway

All Implemented Interfaces:

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

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

Describes a virtual private gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VpnGateway.Builder

Method Summary

Modifier and Type	Method	Description
Long	amazonSideAsn()	The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
String	availabilityZone()	The Availability Zone where the virtual private gateway was created, if applicable.
static VpnGateway.Builder	builder()
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.
boolean	hasVpcAttachments()	For responses, this returns true if the service returned a value for the VpcAttachments property.
List<SdkField<?>>	sdkFields()
static Class<? extends VpnGateway.Builder>	serializableBuilderClass()
VpnState	state()	The current state of the virtual private gateway.
String	stateAsString()	The current state of the virtual private gateway.
List<Tag>	tags()	Any tags assigned to the virtual private gateway.
VpnGateway.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GatewayType	type()	The type of VPN connection the virtual private gateway supports.
String	typeAsString()	The type of VPN connection the virtual private gateway supports.
List<VpcAttachment>	vpcAttachments()	Any VPCs attached to the virtual private gateway.
String	vpnGatewayId()	The ID of the virtual private gateway.

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

availabilityZone

public final String availabilityZone()

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

Returns:

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

state

public final VpnState state()

The current state of the virtual private gateway.

If the service returns an enum value that is not available in the current SDK version, state will return VpnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the virtual private gateway.

See Also:

VpnState

stateAsString

public final String stateAsString()

The current state of the virtual private gateway.

If the service returns an enum value that is not available in the current SDK version, state will return VpnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of the virtual private gateway.

See Also:

VpnState

type

public final GatewayType type()

The type of VPN connection the virtual private gateway supports.

If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of VPN connection the virtual private gateway supports.

See Also:

GatewayType

typeAsString

public final String typeAsString()

The type of VPN connection the virtual private gateway supports.

If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of VPN connection the virtual private gateway supports.

See Also:

GatewayType

hasVpcAttachments

public final boolean hasVpcAttachments()

For responses, this returns true if the service returned a value for the VpcAttachments 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.

vpcAttachments

public final List<VpcAttachment> vpcAttachments()

Any VPCs attached to the virtual private gateway.

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

Returns:

Any VPCs attached to the virtual private gateway.

vpnGatewayId

public final String vpnGatewayId()

The ID of the virtual private gateway.

Returns:

The ID of the virtual private gateway.

amazonSideAsn

public final Long amazonSideAsn()

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

Returns:

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

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

Any tags assigned to the virtual private gateway.

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 virtual private gateway.

toBuilder

public VpnGateway.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VpnGateway.Builder,VpnGateway>

builder

public static VpnGateway.Builder builder()

serializableBuilderClass

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