Amazon Relational Database Service
API Reference (API Version 2014-10-31)

UserAuthConfig

Note

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

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

Contents

AuthScheme

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

Type: String

Valid Values: SECRETS

Required: 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.

Type: String

Valid Values: DISABLED | REQUIRED

Required: 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:

On this page: