Package software.amazon.awscdk.services.rds

Interface CfnDBProxyEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBProxyEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:18.830Z")
@Stability(Stable)
public interface CfnDBProxyEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBProxyEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnDBProxyEndpointProps cfnDBProxyEndpointProps = CfnDBProxyEndpointProps.builder()
         .dbProxyEndpointName("dbProxyEndpointName")
         .dbProxyName("dbProxyName")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .endpointNetworkType("endpointNetworkType")
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetRole("targetRole")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBProxyEndpointProps.Builder	A builder for CfnDBProxyEndpointProps
static final class	CfnDBProxyEndpointProps.Jsii$Proxy	An implementation for CfnDBProxyEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnDBProxyEndpointProps.Builder	builder()
String	getDbProxyEndpointName()	The name of the DB proxy endpoint to create.
String	getDbProxyName()	The name of the DB proxy associated with the DB proxy endpoint that you create.
default String	getEndpointNetworkType()	The network type of the DB proxy endpoint.
default List<CfnDBProxyEndpoint.TagFormatProperty>	getTags()	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
default String	getTargetRole()	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
default List<String>	getVpcSecurityGroupIds()	The VPC security group IDs for the DB proxy endpoint that you create.
List<String>	getVpcSubnetIds()	The VPC subnet IDs for the DB proxy endpoint that you create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbProxyEndpointName

@Stability(Stable)
@NotNull
String getDbProxyEndpointName()

The name of the DB proxy endpoint to create.

See Also:

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

getDbProxyName

@Stability(Stable)
@NotNull
String getDbProxyName()

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

See Also:

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

getVpcSubnetIds

@Stability(Stable)
@NotNull
List<String> getVpcSubnetIds()

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 Also:

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

getEndpointNetworkType

@Stability(Stable)
@Nullable
default String getEndpointNetworkType()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnDBProxyEndpoint.TagFormatProperty> getTags()

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

See Also:

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

getTargetRole

@Stability(Stable)
@Nullable
default String getTargetRole()

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

See Also:

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

getVpcSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getVpcSecurityGroupIds()

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 Also:

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

builder

@Stability(Stable)
static CfnDBProxyEndpointProps.Builder builder()

Returns:

a CfnDBProxyEndpointProps.Builder of CfnDBProxyEndpointProps