Class UserAuthConfig

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

Specifies the details of authentication used by a proxy to log in as a specific database user.

See Also:

  • Method Details

    • description

      public final String description()

      A user-specified description about the authentication used by a proxy to log in as a specific database user.

      Returns:
      A user-specified description about the authentication used by a proxy to log in as a specific database user.

    • userName

      public final String userName()

      The name of the database user to which the proxy connects.

      Returns:
      The name of the database user to which the proxy connects.

    • authScheme

      public final AuthScheme authScheme()

      The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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

      Returns:
      The type of authentication that the proxy uses for connections from the proxy to the underlying database.
      See Also:

    • authSchemeAsString

      public final String authSchemeAsString()

      The type of authentication that the proxy uses for connections from the proxy to the underlying database.

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

      Returns:
      The type of authentication that the proxy uses for connections from the proxy to the underlying database.
      See Also:

    • secretArn

      public final String secretArn()

      The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

      Returns:
      The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    • iamAuth

      public final IAMAuthMode iamAuth()

      A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

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

      Returns:
      A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
      See Also:

    • iamAuthAsString

      public final String iamAuthAsString()

      A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

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

      Returns:
      A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
      See Also:

    • clientPasswordAuthType

      public final ClientPasswordAuthType clientPasswordAuthType()

      The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

      • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD

      • RDS for SQL Server: SQL_SERVER_AUTHENTICATION

      • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

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

      Returns:
      The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

      • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD

      • RDS for SQL Server: SQL_SERVER_AUTHENTICATION

      • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

      See Also:

    • clientPasswordAuthTypeAsString

      public final String clientPasswordAuthTypeAsString()

      The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

      • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD

      • RDS for SQL Server: SQL_SERVER_AUTHENTICATION

      • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

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

      Returns:
      The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines:

      • RDS for MySQL: MYSQL_CACHING_SHA2_PASSWORD

      • RDS for SQL Server: SQL_SERVER_AUTHENTICATION

      • RDS for PostgreSQL: POSTGRES_SCRAM_SHA2_256

      See Also:

    • toBuilder

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

    • builder

      public static UserAuthConfig.Builder builder()

    • serializableBuilderClass

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