Class DBProxyTarget

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

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

See Also:

  • Method Details

    • targetArn

      public final String targetArn()

      The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

      Returns:
      The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

    • endpoint

      public final String endpoint()

      The writer endpoint for the RDS DB instance or Aurora DB cluster.

      Returns:
      The writer endpoint for the RDS DB instance or Aurora DB cluster.

    • trackedClusterId

      public final String trackedClusterId()

      The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

      Returns:
      The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

    • rdsResourceId

      public final String rdsResourceId()

      The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

      Returns:
      The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

    • port

      public final Integer port()

      The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

      Returns:
      The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

    • type

      public final TargetType type()

      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

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

      Returns:
      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

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

      Returns:
      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
      See Also:

    • role

      public final TargetRole role()

      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

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

      Returns:
      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
      See Also:

    • roleAsString

      public final String roleAsString()

      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

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

      Returns:
      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
      See Also:

    • targetHealth

      public final TargetHealth targetHealth()

      Information about the connection health of the RDS Proxy target.

      Returns:
      Information about the connection health of the RDS Proxy target.

    • toBuilder

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

    • builder

      public static DBProxyTarget.Builder builder()

    • serializableBuilderClass

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