Class DBClusterEndpoint

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

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

See Also:

  • Method Details

    • dbClusterEndpointIdentifier

      public final String dbClusterEndpointIdentifier()

      The identifier associated with the endpoint. This parameter is stored as a lowercase string.

      Returns:
      The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

      Returns:
      The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    • dbClusterEndpointResourceIdentifier

      public final String dbClusterEndpointResourceIdentifier()

      A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

      Returns:
      A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    • endpoint

      public final String endpoint()

      The DNS address of the endpoint.

      Returns:
      The DNS address of the endpoint.

    • status

      public final String status()

      The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

      Returns:
      The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

    • endpointType

      public final String endpointType()

      The type of the endpoint. One of: READER, WRITER, CUSTOM.

      Returns:
      The type of the endpoint. One of: READER, WRITER, CUSTOM.

    • customEndpointType

      public final String customEndpointType()

      The type associated with a custom endpoint. One of: READER, WRITER, ANY.

      Returns:
      The type associated with a custom endpoint. One of: READER, WRITER, ANY.

    • hasStaticMembers

      public final boolean hasStaticMembers()
      For responses, this returns true if the service returned a value for the StaticMembers 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.

    • staticMembers

      public final List<String> staticMembers()

      List of DB instance identifiers that are part of the custom endpoint group.

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

      Returns:
      List of DB instance identifiers that are part of the custom endpoint group.

    • hasExcludedMembers

      public final boolean hasExcludedMembers()
      For responses, this returns true if the service returned a value for the ExcludedMembers 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.

    • excludedMembers

      public final List<String> excludedMembers()

      List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

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

      Returns:
      List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    • dbClusterEndpointArn

      public final String dbClusterEndpointArn()

      The Amazon Resource Name (ARN) for the endpoint.

      Returns:
      The Amazon Resource Name (ARN) for the endpoint.

    • toBuilder

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

    • builder

      public static DBClusterEndpoint.Builder builder()

    • serializableBuilderClass

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