CfnDBProxyPropsMixin

class aws_cdk.mixins_preview.aws_rds.mixins.CfnDBProxyPropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_rds import mixins as rds_mixins

cfn_dBProxy_props_mixin = rds_mixins.CfnDBProxyPropsMixin(rds_mixins.CfnDBProxyMixinProps(
    auth=[rds_mixins.CfnDBProxyPropsMixin.AuthFormatProperty(
        auth_scheme="authScheme",
        client_password_auth_type="clientPasswordAuthType",
        description="description",
        iam_auth="iamAuth",
        secret_arn="secretArn"
    )],
    db_proxy_name="dbProxyName",
    debug_logging=False,
    default_auth_scheme="defaultAuthScheme",
    endpoint_network_type="endpointNetworkType",
    engine_family="engineFamily",
    idle_client_timeout=123,
    require_tls=False,
    role_arn="roleArn",
    tags=[rds_mixins.CfnDBProxyPropsMixin.TagFormatProperty(
        key="key",
        value="value"
    )],
    target_connection_network_type="targetConnectionNetworkType",
    vpc_security_group_ids=["vpcSecurityGroupIds"],
    vpc_subnet_ids=["vpcSubnetIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RDS::DBProxy.

Parameters:

props (Union[CfnDBProxyMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['auth', 'dbProxyName', 'debugLogging', 'defaultAuthScheme', 'endpointNetworkType', 'engineFamily', 'idleClientTimeout', 'requireTls', 'roleArn', 'tags', 'targetConnectionNetworkType', 'vpcSecurityGroupIds', 'vpcSubnetIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

AuthFormatProperty

class CfnDBProxyPropsMixin.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.mixins_preview.aws_rds import mixins as rds_mixins

auth_format_property = rds_mixins.CfnDBProxyPropsMixin.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 CfnDBProxyPropsMixin.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.mixins_preview.aws_rds import mixins as rds_mixins

tag_format_property = rds_mixins.CfnDBProxyPropsMixin.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