Class UserAuthConfigInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserAuthConfigInfo.Builder,
UserAuthConfigInfo>
Returns the details of authentication used by a proxy to log in as a specific database user.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.final String
The type of authentication that the proxy uses for connections from the proxy to the underlying database.static UserAuthConfigInfo.Builder
builder()
final ClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.final String
The type of authentication the proxy uses for connections from clients.final String
A user-specified description about the authentication used by a proxy to log in as a specific database user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final IAMAuthMode
iamAuth()
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.final String
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.final String
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 UserAuthConfigInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userName()
The name of the database user to which the proxy connects.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The name of the database user to which the proxy connects.
- Returns:
- The name of the database user to which the proxy connects.
-
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 returnAuthScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthSchemeAsString()
.- Returns:
- The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- See Also:
-
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 returnAuthScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthSchemeAsString()
.- Returns:
- The type of authentication that the proxy uses for connections from the proxy to the underlying database.
- See Also:
-
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
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 returnIAMAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiamAuthAsString()
.- Returns:
- 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
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 returnIAMAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiamAuthAsString()
.- Returns:
- 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
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 returnClientPasswordAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclientPasswordAuthTypeAsString()
.- Returns:
- The type of authentication the proxy uses for connections from clients.
- See Also:
-
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 returnClientPasswordAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclientPasswordAuthTypeAsString()
.- Returns:
- The type of authentication the proxy uses for connections from clients.
- See Also:
-
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 interfaceToCopyableBuilder<UserAuthConfigInfo.Builder,
UserAuthConfigInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-