CfnDBProxyEndpointPropsMixin

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

Bases: Mixin

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

You can use custom proxy endpoints to access a proxy through a different VPC than the proxy’s default VPC.

For more information about RDS Proxy, see AWS::RDS::DBProxy .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html
CloudformationResource:: AWS::RDS::DBProxyEndpoint
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_endpoint_props_mixin = rds_mixins.CfnDBProxyEndpointPropsMixin(rds_mixins.CfnDBProxyEndpointMixinProps(
    db_proxy_endpoint_name="dbProxyEndpointName",
    db_proxy_name="dbProxyName",
    endpoint_network_type="endpointNetworkType",
    tags=[rds_mixins.CfnDBProxyEndpointPropsMixin.TagFormatProperty(
        key="key",
        value="value"
    )],
    target_role="targetRole",
    vpc_security_group_ids=["vpcSecurityGroupIds"],
    vpc_subnet_ids=["vpcSubnetIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDBProxyEndpointMixinProps, 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 = ['dbProxyEndpointName', 'dbProxyName', 'endpointNetworkType', 'tags', 'targetRole', '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

TagFormatProperty

class CfnDBProxyEndpointPropsMixin.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-dbproxyendpoint-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.CfnDBProxyEndpointPropsMixin.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-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-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-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-value