Interface IDatabaseProxyEndpointOptions

Options for a new DatabaseProxyEndpoint.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDatabaseProxyEndpointOptions

Syntax (vb)

Public Interface IDatabaseProxyEndpointOptions

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;
            Secret[] secrets;
            DatabaseInstance dbInstance;


            var proxy = dbInstance.AddProxy("Proxy", new DatabaseProxyOptions {
                Secrets = secrets,
                Vpc = vpc
            });

            // Add a reader endpoint
            proxy.AddEndpoint("ProxyEndpoint", new DatabaseProxyEndpointOptions {
                Vpc = vpc,
                TargetRole = ProxyEndpointTargetRole.READ_ONLY
            });

Synopsis

Properties

DbProxyEndpointName	The name of the DB proxy endpoint.
SecurityGroups	The VPC security groups to associate with the new proxy endpoint.
TargetRole	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
Vpc	The VPC of the DB proxy endpoint.
VpcSubnets	The subnets of DB proxy endpoint.

Properties

DbProxyEndpointName

The name of the DB proxy endpoint.

string? DbProxyEndpointName { get; }

Property Value

string

Remarks

Default: - a CDK generated name

SecurityGroups

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

ISecurityGroup[]? SecurityGroups { get; }

Property Value

ISecurityGroup[]

Remarks

Default: - Default security group for the VPC

TargetRole

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

ProxyEndpointTargetRole? TargetRole { get; }

Property Value

ProxyEndpointTargetRole?

Remarks

Default: - ProxyEndpointTargetRole.READ_WRITE

Vpc

The VPC of the DB proxy endpoint.

IVpc Vpc { get; }

Property Value

IVpc

Remarks

ExampleMetadata: infused

VpcSubnets

The subnets of DB proxy endpoint.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - the VPC default strategy if not specified.