Skip to content

ModifyDBProxyRequest

Source code in docs_src/capo_rds/types/modify_db_proxy_request.py
class ModifyDBProxyRequest(TypedDict, closed=True):
    db_proxy_name: NotRequired["capo_rds.types.db_proxy_name.DBProxyName"]
    """<p>The identifier for the <code>DBProxy</code> to modify.</p>"""
    new_db_proxy_name: NotRequired["capo_rds.types.db_proxy_name.DBProxyName"]
    """<p>The new identifier for the <code>DBProxy</code>. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>"""
    default_auth_scheme: NotRequired[
        "capo_rds.types.default_auth_scheme.DefaultAuthScheme"
    ]
    """<p>The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are <code>NONE</code> and <code>IAM_AUTH</code>. When set to <code>IAM_AUTH</code>, the proxy uses end-to-end IAM authentication to connect to the database.</p>"""
    auth: NotRequired["capo_rds.types.user_auth_config_list.UserAuthConfigList"]
    """<p>The new authentication settings for the <code>DBProxy</code>.</p>"""
    require_tls: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.</p>"""
    idle_client_timeout: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.</p>"""
    debug_logging: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether the proxy logs detailed connection and query information. When you enable <code>DebugLogging</code>, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.</p>"""
    role_arn: NotRequired["capo_rds.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.</p>"""
    security_groups: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The new list of security groups for the <code>DBProxy</code>.</p>"""

auth instance-attribute

auth: NotRequired[UserAuthConfigList]

The new authentication settings for the DBProxy.

db_proxy_name instance-attribute

db_proxy_name: NotRequired[DBProxyName]

The identifier for the DBProxy to modify.

debug_logging instance-attribute

debug_logging: NotRequired[BooleanOptional]

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

default_auth_scheme instance-attribute

default_auth_scheme: NotRequired[DefaultAuthScheme]

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

idle_client_timeout instance-attribute

idle_client_timeout: NotRequired[IntegerOptional]

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

new_db_proxy_name instance-attribute

new_db_proxy_name: NotRequired[DBProxyName]

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

require_tls instance-attribute

require_tls: NotRequired[BooleanOptional]

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.

role_arn instance-attribute

role_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

security_groups instance-attribute

security_groups: NotRequired[StringList]

The new list of security groups for the DBProxy.