Skip to content

UserAuthConfigInfo

Source code in docs_src/capo_rds/types/user_auth_config_info.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class UserAuthConfigInfo(TypedDict, closed=True):
    description: NotRequired["capo_rds.types.string.String"]
    """<p>A user-specified description about the authentication used by a proxy to log in as a specific database user.</p>"""
    user_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the database user to which the proxy connects.</p>"""
    auth_scheme: NotRequired["capo_rds.types.auth_scheme.AuthScheme"]
    """<p>The type of authentication that the proxy uses for connections from the proxy to the underlying database.</p>"""
    secret_arn: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    iam_auth: NotRequired["capo_rds.types.iam_auth_mode.IAMAuthMode"]
    """<p>Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. </p>"""
    client_password_auth_type: NotRequired[
        "capo_rds.types.client_password_auth_type.ClientPasswordAuthType"
    ]
    """<p>The type of authentication the proxy uses for connections from clients.</p>"""

auth_scheme instance-attribute 

auth_scheme: NotRequired[AuthScheme]

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: NotRequired[ClientPasswordAuthType]

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

description instance-attribute 

description: NotRequired[String]

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: NotRequired[IAMAuthMode]

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

secret_arn instance-attribute 

secret_arn: NotRequired[String]

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: NotRequired[String]

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