Interface ICfnDBProxyProps

Properties for defining a CfnDBProxy.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDBProxyProps

Syntax (vb)

Public Interface ICfnDBProxyProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnDBProxyProps = new CfnDBProxyProps {
                 DbProxyName = "dbProxyName",
                 EngineFamily = "engineFamily",
                 RoleArn = "roleArn",
                 VpcSubnetIds = new [] { "vpcSubnetIds" },

                 // the properties below are optional
                 Auth = new [] { new AuthFormatProperty {
                     AuthScheme = "authScheme",
                     ClientPasswordAuthType = "clientPasswordAuthType",
                     Description = "description",
                     IamAuth = "iamAuth",
                     SecretArn = "secretArn"
                 } },
                 DebugLogging = false,
                 DefaultAuthScheme = "defaultAuthScheme",
                 EndpointNetworkType = "endpointNetworkType",
                 IdleClientTimeout = 123,
                 RequireTls = false,
                 Tags = new [] { new TagFormatProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetConnectionNetworkType = "targetConnectionNetworkType",
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             };

Synopsis

Properties

Auth	The authorization mechanism that the proxy uses.
DbProxyName	The identifier for the proxy.
DebugLogging	Specifies whether the proxy logs detailed connection and query information.
DefaultAuthScheme	The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
EndpointNetworkType	The network type of the DB proxy endpoint.
EngineFamily	The kinds of databases that the proxy can connect to.
IdleClientTimeout	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
RequireTls	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
RoleArn	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
Tags	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
TargetConnectionNetworkType	The network type that the proxy uses to connect to the target database.
VpcSecurityGroupIds	One or more VPC security group IDs to associate with the new proxy.
VpcSubnetIds	One or more VPC subnet IDs to associate with the new proxy.

Properties

Auth

The authorization mechanism that the proxy uses.

object? Auth { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth

Type union: either IResolvable or (either IResolvable or CfnDBProxy.IAuthFormatProperty)[]

DbProxyName

The identifier for the proxy.

string DbProxyName { get; }

Property Value

string

Remarks

This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

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

DebugLogging

Specifies whether the proxy logs detailed connection and query information.

object? DebugLogging { get; }

Property Value

object

Remarks

When you enable DebugLogging , the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging

Type union: either bool or IResolvable

DefaultAuthScheme

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.

string? DefaultAuthScheme { get; }

Property Value

string

Remarks

Valid values are NONE and IAM_AUTH . When set to IAM_AUTH , the proxy uses end-to-end IAM authentication to connect to the database.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-defaultauthscheme

EndpointNetworkType

The network type of the DB proxy endpoint.

string? EndpointNetworkType { get; }

Property Value

string

Remarks

The network type determines the IP version that the proxy endpoint supports.

Valid values:

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

EngineFamily

The kinds of databases that the proxy can connect to.

string EngineFamily { get; }

Property Value

string

Remarks

This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify SQLSERVER .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily

IdleClientTimeout

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

double? IdleClientTimeout { get; }

Property Value

double?

Remarks

You can set this value higher or lower than the connection timeout limit for the associated database.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout

RequireTls

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

object? RequireTls { get; }

Property Value

object

Remarks

By enabling this setting, you can enforce encrypted TLS connections to the proxy.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls

Type union: either bool or IResolvable

RoleArn

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

object RoleArn { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn

Type union: either string or IRoleRef

TargetConnectionNetworkType

The network type that the proxy uses to connect to the target database.

string? TargetConnectionNetworkType { get; }

Property Value

string

Remarks

The network type determines the IP version that the proxy uses for connections to the database.

Valid values:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-targetconnectionnetworktype

VpcSecurityGroupIds

One or more VPC security group IDs to associate with the new proxy.

object[]? VpcSecurityGroupIds { get; }

Property Value

object[]

Remarks

If you plan to update the resource, don't specify VPC security groups in a shared VPC.

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

Type union: (either string or ISecurityGroupRef)[]

VpcSubnetIds

One or more VPC subnet IDs to associate with the new proxy.

object[] VpcSubnetIds { get; }

Property Value

object[]

Remarks

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

Type union: (either string or ISubnetRef)[]