Skip to content

RDS  >  Dictionaries  >  UserAuthConfigDict

UserAuthConfigDict

Dictionary Type

UserAuthConfigDict

Bases: TypedDict

Dictionary form of UserAuthConfig.

Attributes

auth_scheme instance-attribute
auth_scheme: str | None

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

client_password_auth_type instance-attribute
client_password_auth_type: str | None

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

description instance-attribute
description: str | None

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

iam_auth instance-attribute
iam_auth: str | None

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.

secret_arn instance-attribute
secret_arn: str | None

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.

user_name instance-attribute
user_name: str | None

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