CfnDBProxyProps

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

Bases: object

Properties for defining a CfnDBProxy.

Parameters
  • auth (Union[IResolvable, Sequence[Union[IResolvable, AuthFormatProperty]]]) – The authorization mechanism that the proxy uses.

  • 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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora. Valid values : MYSQL | POSTGRESQL

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

  • debug_logging (Union[bool, IResolvable, None]) – Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

  • 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]) – A Boolean parameter that 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[TagFormatProperty]]) – An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

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

Link

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.
import aws_cdk.aws_rds as rds

cfn_dBProxy_props = rds.CfnDBProxyProps(
    auth=[rds.CfnDBProxy.AuthFormatProperty(
        auth_scheme="authScheme",
        description="description",
        iam_auth="iamAuth",
        secret_arn="secretArn",
        user_name="userName"
    )],
    db_proxy_name="dbProxyName",
    engine_family="engineFamily",
    role_arn="roleArn",
    vpc_subnet_ids=["vpcSubnetIds"],

    # the properties below are optional
    debug_logging=False,
    idle_client_timeout=123,
    require_tls=False,
    tags=[rds.CfnDBProxy.TagFormatProperty(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

auth

The authorization mechanism that the proxy uses.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AuthFormatProperty]]]

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.

Link

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

Return type

str

debug_logging

Whether the proxy includes detailed information about SQL statements in its logs.

This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Link

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

Return type

Union[bool, IResolvable, None]

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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Valid values : MYSQL | POSTGRESQL

Link

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

Return type

str

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.

Link

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

Return type

Union[int, float, None]

require_tls

A Boolean parameter that 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.

Link

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

Return type

Union[bool, IResolvable, None]

role_arn

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

Link

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

Return type

str

tags

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

Link

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

Return type

Optional[List[TagFormatProperty]]

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.

Link

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

Return type

Optional[List[str]]

vpc_subnet_ids

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

Link

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

Return type

List[str]