Package software.amazon.awssdk.services.rds.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserAuthConfig.Builder

Method Summary

Modifier and Type	Method	Description
AuthScheme	authScheme()	The type of authentication that the proxy uses for connections from the proxy to the underlying database.
String	authSchemeAsString()	The type of authentication that the proxy uses for connections from the proxy to the underlying database.
static UserAuthConfig.Builder	builder()
ClientPasswordAuthType	clientPasswordAuthType()	The type of authentication the proxy uses for connections from clients.
String	clientPasswordAuthTypeAsString()	The type of authentication the proxy uses for connections from clients.
String	description()	A user-specified description about the authentication used by a proxy to log in as a specific database user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
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.
static Class<? extends UserAuthConfig.Builder>	serializableBuilderClass()
UserAuthConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The name of the database user to which the proxy connects.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AuthScheme

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:

AuthScheme

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:

IAMAuthMode

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:

IAMAuthMode

clientPasswordAuthType

public final ClientPasswordAuthType clientPasswordAuthType()

The type of authentication the proxy uses for connections from clients.

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.

See Also:

ClientPasswordAuthType

clientPasswordAuthTypeAsString

public final String clientPasswordAuthTypeAsString()

The type of authentication the proxy uses for connections from clients.

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.

See Also:

ClientPasswordAuthType

toBuilder

public UserAuthConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserAuthConfig.Builder,UserAuthConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo