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:

  • Method Details

    • 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.

    • 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

    • customerGatewayId

      public final String customerGatewayId()

      The ID of the customer gateway.

      Returns:
      The ID of the customer gateway.

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

    • ipAddress

      public final String ipAddress()

      The IP 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. If OutsideIpAddressType is set to Ipv6, you can use a public IPv6 address.

      Returns:
      The IP 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. If OutsideIpAddressType is set to Ipv6, you can use a public IPv6 address.

    • 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

    • toBuilder

      public CustomerGateway.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<CustomerGateway.Builder,CustomerGateway>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.