CfnDBProxy

class aws_cdk.aws_rds.CfnDBProxy(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::RDS::DBProxy.

The AWS::RDS::DBProxy resource creates or updates a DB proxy.

For information about RDS Proxy for Amazon RDS, see Managing Connections with Amazon RDS Proxy in the Amazon RDS User Guide .

For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy in the Amazon Aurora User Guide . .. epigraph:

Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.

For information about limitations that apply to RDS Proxy for Amazon RDS, see `Limitations for RDS Proxy <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations>`_ in the *Amazon RDS User Guide* .

For information about that apply to RDS Proxy for Amazon Aurora, see `Limitations for RDS Proxy <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations>`_ in the *Amazon Aurora User Guide* .
CloudformationResource

AWS::RDS::DBProxy

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 = rds.CfnDBProxy(self, "MyCfnDBProxy",
    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"]
)

Create a new AWS::RDS::DBProxy.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • auth (Union[IResolvable, Sequence[Union[IResolvable, AuthFormatProperty, Dict[str, Any]]]]) – 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[Union[TagFormatProperty, Dict[str, Any]]]]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::RDS::DBProxy'
attr_db_proxy_arn

The Amazon Resource Name (ARN) representing the target group.

CloudformationAttribute

DBProxyArn

Return type

str

attr_endpoint

The writer endpoint for the RDS DB instance or Aurora DB cluster.

CloudformationAttribute

Endpoint

Return type

str

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]]]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AuthFormatProperty

class CfnDBProxy.AuthFormatProperty(*, auth_scheme=None, description=None, iam_auth=None, secret_arn=None, user_name=None)

Bases: object

Specifies the details of authentication used by a proxy to log in as a specific database user.

Parameters
  • auth_scheme (Optional[str]) – The type of authentication that the proxy uses for connections from the proxy to the underlying database. Valid Values: SECRETS

  • description (Optional[str]) – A user-specified description about the authentication used by a proxy to log in as a specific database user.

  • iam_auth (Optional[str]) – Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. Valid Values: DISABLED | REQUIRED

  • secret_arn (Optional[str]) – 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.

  • user_name (Optional[str]) – The name of the database user to which the proxy connects.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.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

auth_format_property = rds.CfnDBProxy.AuthFormatProperty(
    auth_scheme="authScheme",
    description="description",
    iam_auth="iamAuth",
    secret_arn="secretArn",
    user_name="userName"
)

Attributes

auth_scheme

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

Valid Values: SECRETS

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme

Return type

Optional[str]

description

A user-specified description about the authentication used by a proxy to log in as a specific database user.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-description

Return type

Optional[str]

iam_auth

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Valid Values: DISABLED | REQUIRED

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth

Return type

Optional[str]

secret_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-secretarn

Return type

Optional[str]

user_name

The name of the database user to which the proxy connects.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-username

Return type

Optional[str]

TagFormatProperty

class CfnDBProxy.TagFormatProperty(*, key=None, value=None)

Bases: object

Metadata assigned to a DB proxy consisting of a key-value pair.

Parameters
  • key (Optional[str]) – A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can’t be prefixed with aws: . The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).

  • value (Optional[str]) – A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed with aws: . The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.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

tag_format_property = rds.CfnDBProxy.TagFormatProperty(
    key="key",
    value="value"
)

Attributes

key

A key is the required name of the tag.

The string value can be 1-128 Unicode characters in length and can’t be prefixed with aws: . The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-key

Return type

Optional[str]

value

A value is the optional value of the tag.

The string value can be 1-256 Unicode characters in length and can’t be prefixed with aws: . The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-value

Return type

Optional[str]