AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDBProxy operation. Creates a new DB proxy.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.CreateDBProxyRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDBProxyRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The CreateDBProxyRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDBProxyRequest()

Properties

NameTypeDescription
Public Property Auth System.Collections.Generic.List<Amazon.RDS.Model.UserAuthConfig>

Gets and sets the property Auth.

The authorization mechanism that the proxy uses.

Public Property DBProxyName System.String

Gets and sets the property DBProxyName.

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services 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.

Public Property DebugLogging System.Boolean

Gets and sets the property DebugLogging.

Specifies whether the proxy logs detailed connection and query information. 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.

Public Property EndpointNetworkType Amazon.RDS.EndpointNetworkType

Gets and sets the property EndpointNetworkType.

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.

Default: IPV4

Constraints:

  • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

  • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

Public Property EngineFamily Amazon.RDS.EngineFamily

Gets and sets the property EngineFamily.

The kinds of databases that the proxy can connect to. 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.

Public Property IdleClientTimeout System.Int32

Gets and sets the property IdleClientTimeout.

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

Public Property RequireTLS System.Boolean

Gets and sets the property RequireTLS.

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag>

Gets and sets the property Tags.

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

Public Property TargetConnectionNetworkType Amazon.RDS.TargetConnectionNetworkType

Gets and sets the property TargetConnectionNetworkType.

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

Valid values:

  • IPV4 - The proxy connects to the database using IPv4 only.

  • IPV6 - The proxy connects to the database using IPv6 only.

Default: IPV4

Constraints:

  • If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.

  • All targets registered with the proxy must be compatible with the specified network type.

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property VpcSecurityGroupIds.

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

Public Property VpcSubnetIds System.Collections.Generic.List<System.String>

Gets and sets the property VpcSubnetIds.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5