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

Class CustomerGateway

java.lang.Object

software.amazon.awssdk.services.ec2.model.CustomerGateway

All Implemented Interfaces:

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

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

Describes a customer gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomerGateway.Builder

Method Summary

Modifier and Type	Method	Description
String	bgpAsn()	The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
String	bgpAsnExtended()	The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
static CustomerGateway.Builder	builder()
String	certificateArn()	The Amazon Resource Name (ARN) for the customer gateway certificate.
String	customerGatewayId()	The ID of the customer gateway.
String	deviceName()	The name of customer gateway device.
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.
String	ipAddress()	IPv4 address for the customer gateway device's outside interface.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomerGateway.Builder>	serializableBuilderClass()
String	state()	The current state of the customer gateway (pending | available | deleting | deleted).
List<Tag>	tags()	Any tags assigned to the customer gateway.
CustomerGateway.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of VPN connection the customer gateway supports (ipsec.1).

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

bgpAsn

public final String bgpAsn()

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Valid values: 1 to 2,147,483,647

Returns:

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Valid values: 1 to 2,147,483,647

customerGatewayId

public final String customerGatewayId()

The ID of the customer gateway.

Returns:

The ID of the customer gateway.

ipAddress

public final String ipAddress()

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Returns:

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

certificateArn

public final String certificateArn()

The Amazon Resource Name (ARN) for the customer gateway certificate.

Returns:

The Amazon Resource Name (ARN) for the customer gateway certificate.

state

public final String state()

The current state of the customer gateway (pending | available | deleting | deleted).

Returns:

The current state of the customer gateway (pending | available | deleting | deleted).

type

public final String type()

The type of VPN connection the customer gateway supports (ipsec.1).

Returns:

The type of VPN connection the customer gateway supports (ipsec.1).

deviceName

public final String deviceName()

The name of customer gateway device.

Returns:

The name of customer gateway device.

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 customer 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 customer gateway.

bgpAsnExtended

public final String bgpAsnExtended()

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Valid values: 2,147,483,648 to 4,294,967,295

Returns:

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Valid values: 2,147,483,648 to 4,294,967,295

toBuilder

public CustomerGateway.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomerGateway.Builder,CustomerGateway>

builder

public static CustomerGateway.Builder builder()

serializableBuilderClass

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