DBProxy ¶

class DBProxy(TypedDict, closed=True):
    db_proxy_name: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>"""
    db_proxy_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the proxy.</p>"""
    status: NotRequired["capo_rds.types.db_proxy_status.DBProxyStatus"]
    """<p>The current status of this proxy. A status of <code>available</code> means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.</p>"""
    engine_family: NotRequired["capo_rds.types.string.String"]
    """<p>The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. <code>MYSQL</code> supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. <code>POSTGRESQL</code> supports Aurora PostgreSQL and RDS for PostgreSQL databases. <code>SQLSERVER</code> supports RDS for Microsoft SQL Server databases.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>Provides the VPC ID of the DB proxy.</p>"""
    vpc_security_group_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>Provides a list of VPC security groups that the proxy belongs to.</p>"""
    vpc_subnet_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The EC2 subnet IDs for the proxy.</p>"""
    default_auth_scheme: NotRequired["capo_rds.types.string.String"]
    """<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_info_list.UserAuthConfigInfoList"
    ]
    """<p>One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.</p>"""
    role_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.</p>"""
    endpoint: NotRequired["capo_rds.types.string.String"]
    """<p>The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.</p>"""
    require_tls: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.</p>"""
    idle_client_timeout: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.</p> <p>Default: 1800 (30 minutes)</p> <p>Constraints: 1 to 28,800</p>"""
    debug_logging: NotRequired["capo_rds.types.boolean.Boolean"]
    """<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>"""
    created_date: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The date and time when the proxy was first created.</p>"""
    updated_date: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The date and time when the proxy was last updated.</p>"""
    endpoint_network_type: NotRequired[
        "capo_rds.types.endpoint_network_type.EndpointNetworkType"
    ]
    """<p>The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.</p> <p>Valid values:</p> <ul> <li> <p> <code>IPV4</code> - The proxy endpoint supports IPv4 only.</p> </li> <li> <p> <code>IPV6</code> - The proxy endpoint supports IPv6 only.</p> </li> <li> <p> <code>DUAL</code> - The proxy endpoint supports both IPv4 and IPv6.</p> </li> </ul>"""
    target_connection_network_type: NotRequired[
        "capo_rds.types.target_connection_network_type.TargetConnectionNetworkType"
    ]
    """<p>The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.</p> <p>Valid values:</p> <ul> <li> <p> <code>IPV4</code> - The proxy connects to the database using IPv4 only.</p> </li> <li> <p> <code>IPV6</code> - The proxy connects to the database using IPv6 only.</p> </li> </ul>"""