UserAuthConfig ¶

class UserAuthConfig(TypedDict, closed=True):
    description: NotRequired["capo_rds.types.description.Description"]
    """<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.auth_user_name.AuthUserName"]
    """<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.arn.Arn"]
    """<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>A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The <code>ENABLED</code> value is valid only for proxies with RDS for Microsoft SQL Server.</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. The following values are defaults for the corresponding engines:</p> <ul> <li> <p>RDS for MySQL: <code>MYSQL_CACHING_SHA2_PASSWORD</code> </p> </li> <li> <p>RDS for SQL Server: <code>SQL_SERVER_AUTHENTICATION</code> </p> </li> <li> <p>RDS for PostgreSQL: <code>POSTGRES_SCRAM_SHA2_256</code> </p> </li> </ul>"""