CfnDBProxyProps

class aws_cdk.aws_rds.CfnDBProxyProps(*, db_proxy_name, engine_family, role_arn, vpc_subnet_ids, auth=None, debug_logging=None, default_auth_scheme=None, endpoint_network_type=None, idle_client_timeout=None, require_tls=None, tags=None, target_connection_network_type=None, vpc_security_group_ids=None)

Bases: object

Properties for defining a CfnDBProxy.

Parameters:

db_proxy_name (str) – The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region . 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.
engine_family (str) – 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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify SQLSERVER .
role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpc_subnet_ids (Sequence[str]) – One or more VPC subnet IDs to associate with the new proxy.
auth (Union[IResolvable, Sequence[Union[IResolvable, AuthFormatProperty, Dict[str, Any]]], None]) – The authorization mechanism that the proxy uses.
debug_logging (Union[bool, IResolvable, None]) – 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 (Optional[str]) – 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.
endpoint_network_type (Optional[str]) – The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports. Valid values: - IPV4 - The proxy endpoint supports IPv4 only. - IPV6 - The proxy endpoint supports IPv6 only. - DUAL - The proxy endpoint supports both IPv4 and IPv6.
idle_client_timeout (Union[int, float, None]) – 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.
require_tls (Union[bool, IResolvable, None]) – Specifies 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.
tags (Optional[Sequence[Union[TagFormatProperty, Dict[str, Any]]]]) – An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
target_connection_network_type (Optional[str]) – 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. Valid values: - IPV4 - The proxy connects to the database using IPv4 only. - IPV6 - The proxy connects to the database using IPv6 only.
vpc_security_group_ids (Optional[Sequence[str]]) – One or more VPC security group IDs to associate with the new proxy. If you plan to update the resource, don’t specify VPC security groups in a shared VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_dBProxy_props = rds.CfnDBProxyProps(
    db_proxy_name="dbProxyName",
    engine_family="engineFamily",
    role_arn="roleArn",
    vpc_subnet_ids=["vpcSubnetIds"],

    # the properties below are optional
    auth=[rds.CfnDBProxy.AuthFormatProperty(
        auth_scheme="authScheme",
        client_password_auth_type="clientPasswordAuthType",
        description="description",
        iam_auth="iamAuth",
        secret_arn="secretArn"
    )],
    debug_logging=False,
    default_auth_scheme="defaultAuthScheme",
    endpoint_network_type="endpointNetworkType",
    idle_client_timeout=123,
    require_tls=False,
    tags=[rds.CfnDBProxy.TagFormatProperty(
        key="key",
        value="value"
    )],
    target_connection_network_type="targetConnectionNetworkType",
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

auth

The authorization mechanism that the proxy uses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth

db_proxy_name

The identifier for the proxy.

This name must be unique for all proxies owned by your AWS account in the specified AWS Region . 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-dbproxyname

debug_logging

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging

default_auth_scheme

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-defaultauthscheme

endpoint_network_type

The network type of the DB proxy endpoint.

The network type determines the IP version that the proxy endpoint supports.

Valid values:

IPV4 - The proxy endpoint supports IPv4 only.
IPV6 - The proxy endpoint supports IPv6 only.
DUAL - The proxy endpoint supports both IPv4 and IPv6.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-endpointnetworktype

engine_family

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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify SQLSERVER .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily

idle_client_timeout

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout

require_tls

Specifies 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls

role_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn

tags

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-tags

target_connection_network_type

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.

Valid values:

IPV4 - The proxy connects to the database using IPv4 only.
IPV6 - The proxy connects to the database using IPv6 only.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-targetconnectionnetworktype

vpc_security_group_ids

One or more VPC security group IDs to associate with the new proxy.

If you plan to update the resource, don’t specify VPC security groups in a shared VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsecuritygroupids

vpc_subnet_ids

One or more VPC subnet IDs to associate with the new proxy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsubnetids