CfnDBProxy

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

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html
CloudformationResource:: AWS::RDS::DBProxy
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 = rds.CfnDBProxy(self, "MyCfnDBProxy",
    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"]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

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_dependency(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_depends_on(target)

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

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

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.

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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) for the proxy.

CloudformationAttribute:: DBProxyArn

attr_endpoint

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.

CloudformationAttribute:: Endpoint

attr_vpc_id

The VPC ID to associate with the DB proxy.

CloudformationAttribute:: VpcId

auth: The authorization mechanism that the proxy uses.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

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

cfn_resource_type: AWS resource type.

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.

db_proxy_name: The identifier for the proxy.

db_proxy_ref: A reference to a DBProxy resource.

debug_logging: Specifies whether the proxy logs detailed connection and query information.

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.

endpoint_network_type: The network type of the DB proxy endpoint.

engine_family: The kinds of databases that the proxy can connect to.

idle_client_timeout: The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

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

Returns:

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

node: The tree node.

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 }).

require_tls: Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

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

stack

The stack in which this element is defined.

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

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

target_connection_network_type: The network type that the proxy uses to connect to the target database.

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

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

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(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AuthFormatProperty

class CfnDBProxy.AuthFormatProperty(*, auth_scheme=None, client_password_auth_type=None, description=None, iam_auth=None, secret_arn=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.
client_password_auth_type (Optional[str]) – Specifies the details of authentication used by a proxy to log in as a specific database user.
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]) – A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
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.

See:

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

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

Attributes

auth_scheme

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

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

client_password_auth_type

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

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

description

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

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

iam_auth

A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

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

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.

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

TagFormatProperty

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

Bases: object

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide .

Parameters:

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

See:

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.
from aws_cdk import 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 from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-@]*)$”).

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

value

A value is the optional value of the tag.

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

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