Class Connection

java.lang.Object
software.amazon.awssdk.services.interconnect.model.Connection
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Connection.Builder,Connection>
@Generated("software.amazon.awssdk:codegen") public final class Connection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Connection.Builder,Connection>

The object describing the provided connectivity from the AWS region to the partner location.

See Also:

  • Method Details

    • id

      public final String id()

      The short identifier of the connection object.

      Returns:
      The short identifier of the connection object.

    • arn

      public final String arn()

      An ARN of a Connection object.

      Returns:
      An ARN of a Connection object.

    • description

      public final String description()

      A descriptive name for the connection.

      Returns:
      A descriptive name for the connection.

    • bandwidth

      public final String bandwidth()

      The specific selected bandwidth of this connection.

      Returns:
      The specific selected bandwidth of this connection.

    • attachPoint

      public final AttachPoint attachPoint()

      The Attach Point to which the connection should be associated."

      Returns:
      The Attach Point to which the connection should be associated."

    • environmentId

      public final String environmentId()

      The specific Environment this connection is placed upon.

      Returns:
      The specific Environment this connection is placed upon.

    • provider

      public final Provider provider()

      The provider on the remote side of this Connection.

      Returns:
      The provider on the remote side of this Connection.

    • location

      public final String location()

      The provider specific location on the remote side of this Connection

      Returns:
      The provider specific location on the remote side of this Connection

    • type

      public final String type()

      The specific product type of this Connection.

      Returns:
      The specific product type of this Connection.

    • state

      public final ConnectionState state()

      • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

      • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

      • available: The connection has been fully provisioned between AWS and the Partner.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • failed: The connection has failed to be created.

      • updating: The connection is being updated.

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

      Returns:

    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

    • available: The connection has been fully provisioned between AWS and the Partner.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • failed: The connection has failed to be created.

    • updating: The connection is being updated.

      • See Also:

    • stateAsString

      public final String stateAsString()

      • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

      • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

      • available: The connection has been fully provisioned between AWS and the Partner.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • failed: The connection has failed to be created.

      • updating: The connection is being updated.

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

      Returns:

    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

    • available: The connection has been fully provisioned between AWS and the Partner.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • failed: The connection has failed to be created.

    • updating: The connection is being updated.

      • See Also:

    • sharedId

      public final String sharedId()

      An identifier used by both AWS and the remote partner to identify the specific connection.

      Returns:
      An identifier used by both AWS and the remote partner to identify the specific connection.

    • billingTier

      public final Integer billingTier()

      The billing tier this connection is currently assigned.

      Returns:
      The billing tier this connection is currently assigned.

    • ownerAccount

      public final String ownerAccount()

      The account that owns this Connection

      Returns:
      The account that owns this Connection

    • activationKey

      public final String activationKey()

      The Activation Key associated to this connection.

      Returns:
      The Activation Key associated to this 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 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 Map<String,String> tags()

      The tags on the 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:
      The tags on the Connection

    • toBuilder

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

    • builder

      public static Connection.Builder builder()

    • serializableBuilderClass

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