Package software.amazon.awscdk.services.rds

Interface DatabaseProxyEndpointOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DatabaseProxyEndpointProps

All Known Implementing Classes:

DatabaseProxyEndpointOptions.Jsii$Proxy, DatabaseProxyEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:59.144Z")
@Stability(Stable)
public interface DatabaseProxyEndpointOptions
extends software.amazon.jsii.JsiiSerializable

Options for a new DatabaseProxyEndpoint.

Example:

 Vpc vpc;
 Secret[] secrets;
 DatabaseInstance dbInstance;
 DatabaseProxy proxy = dbInstance.addProxy("Proxy", DatabaseProxyOptions.builder()
         .secrets(secrets)
         .vpc(vpc)
         .build());
 // Add a reader endpoint
 proxy.addEndpoint("ProxyEndpoint", DatabaseProxyEndpointOptions.builder()
         .vpc(vpc)
         .targetRole(ProxyEndpointTargetRole.READ_ONLY)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DatabaseProxyEndpointOptions.Builder	builder()
default String	getDbProxyEndpointName()	The name of the DB proxy endpoint.
default List<ISecurityGroup>	getSecurityGroups()	The VPC security groups to associate with the new proxy endpoint.
default ProxyEndpointTargetRole	getTargetRole()	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IVpc	getVpc()	The VPC of the DB proxy endpoint.
default SubnetSelection	getVpcSubnets()	The subnets of DB proxy endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpc

@Stability(Stable)
@NotNull
IVpc getVpc()

The VPC of the DB proxy endpoint.

getDbProxyEndpointName

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

The name of the DB proxy endpoint.

Default: - a CDK generated name

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

The VPC security groups to associate with the new proxy endpoint.

Default: - Default security group for the VPC

getTargetRole

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

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

Default: - ProxyEndpointTargetRole.READ_WRITE

getVpcSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getVpcSubnets()

The subnets of DB proxy endpoint.

Default: - the VPC default strategy if not specified.

builder

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

Returns:

a DatabaseProxyEndpointOptions.Builder of DatabaseProxyEndpointOptions