CfnDBProxyEndpointProps

class aws_cdk.aws_rds.CfnDBProxyEndpointProps(*, db_proxy_endpoint_name, db_proxy_name, vpc_subnet_ids, tags=None, target_role=None, vpc_security_group_ids=None)

Bases: object

Properties for defining a CfnDBProxyEndpoint.

Parameters:
  • db_proxy_endpoint_name (str) – The name of the DB proxy endpoint to create.

  • db_proxy_name (str) – The name of the DB proxy associated with the DB proxy endpoint that you create.

  • vpc_subnet_ids (Sequence[str]) – The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB 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_role (Optional[str]) – A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. Valid Values: READ_WRITE | READ_ONLY

  • vpc_security_group_ids (Optional[Sequence[str]]) – The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

See:

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

cfn_dBProxy_endpoint_props = rds.CfnDBProxyEndpointProps(
    db_proxy_endpoint_name="dbProxyEndpointName",
    db_proxy_name="dbProxyName",
    vpc_subnet_ids=["vpcSubnetIds"],

    # the properties below are optional
    tags=[rds.CfnDBProxyEndpoint.TagFormatProperty(
        key="key",
        value="value"
    )],
    target_role="targetRole",
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

db_proxy_endpoint_name

The name of the DB proxy endpoint to create.

See:

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

db_proxy_name

The name of the DB proxy associated with the DB proxy endpoint that you create.

See:

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

tags

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

See:

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

target_role

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Valid Values: READ_WRITE | READ_ONLY

See:

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

vpc_security_group_ids

The VPC security group IDs for the DB proxy endpoint that you create.

You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

See:

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

vpc_subnet_ids

The VPC subnet IDs for the DB proxy endpoint that you create.

You can specify a different set of subnet IDs than for the original DB proxy.

See:

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