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.

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBProxy

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

Syntax

C#
public class DBProxy

The DBProxy type exposes the following members

Constructors

NameDescription
Public Method DBProxy()

Properties

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

Gets and sets the property Auth.

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The date and time when the proxy was first created.

Public Property DBProxyArn System.String

Gets and sets the property DBProxyArn.

The Amazon Resource Name (ARN) for the proxy.

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.

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 Endpoint System.String

Gets and sets the property Endpoint.

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

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.

Public Property EngineFamily System.String

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. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

Public Property IdleClientTimeout System.Int32

Gets and sets the property IdleClientTimeout.

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

Public Property RequireTLS System.Boolean

Gets and sets the property RequireTLS.

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

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Public Property Status Amazon.RDS.DBProxyStatus

Gets and sets the property Status.

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

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.

Public Property UpdatedDate System.DateTime

Gets and sets the property UpdatedDate.

The date and time when the proxy was last updated.

Public Property VpcId System.String

Gets and sets the property VpcId.

Provides the VPC ID of the DB proxy.

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

Gets and sets the property VpcSecurityGroupIds.

Provides a list of VPC security groups that the proxy belongs to.

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

Gets and sets the property VpcSubnetIds.

The EC2 subnet IDs for the 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