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 {
                 Auth = new [] { new AuthFormatProperty {
                     AuthScheme = "authScheme",
                     ClientPasswordAuthType = "clientPasswordAuthType",
                     Description = "description",
                     IamAuth = "iamAuth",
                     SecretArn = "secretArn"
                 } },
                 DbProxyName = "dbProxyName",
                 EngineFamily = "engineFamily",
                 RoleArn = "roleArn",
                 VpcSubnetIds = new [] { "vpcSubnetIds" },

                 // the properties below are optional
                 DebugLogging = false,
                 IdleClientTimeout = 123,
                 RequireTls = false,
                 Tags = new [] { new TagFormatProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             };

Synopsis

Properties

Auth	The authorization mechanism that the proxy uses.
DbProxyName	The identifier for the proxy.
DebugLogging	Specifies whether the proxy includes detailed information about SQL statements in its logs.
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.
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

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 includes detailed information about SQL statements in its logs.

object? DebugLogging { get; }

Property Value

object

Remarks

This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

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

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

RoleArn

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

string RoleArn { get; }

Property Value

string

Remarks

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

VpcSecurityGroupIds

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

string[]? VpcSecurityGroupIds { get; }

Property Value

string[]

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

VpcSubnetIds

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

string[] VpcSubnetIds { get; }

Property Value

string[]

Remarks

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