UserAuthConfigInfo
Returns the details of authentication used by a proxy to log in as a specific database user.
Contents
Note
In the following list, the required parameters are described first.
- AuthScheme
-
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
Type: String
Valid Values:
SECRETSRequired: No
- ClientPasswordAuthType
-
The type of authentication the proxy uses for connections from clients.
Type: String
Valid Values:
MYSQL_NATIVE_PASSWORD | POSTGRES_SCRAM_SHA_256 | POSTGRES_MD5 | SQL_SERVER_AUTHENTICATIONRequired: No
- Description
-
A user-specified description about the authentication used by a proxy to log in as a specific database user.
Type: String
Required: No
- IAMAuth
-
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. The
ENABLEDvalue is valid only for proxies with RDS for Microsoft SQL Server.Type: String
Valid Values:
DISABLED | REQUIRED | ENABLEDRequired: No
- 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.
Type: String
Required: No
- UserName
-
The name of the database user to which the proxy connects.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
