DBProxy class

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

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

Constructors

DBProxy({List<UserAuthConfigInfo>? auth, DateTime? createdDate, String? dBProxyArn, String? dBProxyName, bool? debugLogging, String? endpoint, String? engineFamily, int? idleClientTimeout, bool? requireTLS, String? roleArn, DBProxyStatus? status, DateTime? updatedDate, List<String>? vpcSecurityGroupIds, List<String>? vpcSubnetIds})

DBProxy.fromXml(XmlElement elem)

factory

Properties

auth → List<UserAuthConfigInfo>?

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

final

createdDate → DateTime?

The date and time when the proxy was first created.

final

dBProxyArn → String?

The Amazon Resource Name (ARN) for the proxy.

final

dBProxyName → String?

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

final

debugLogging → bool?

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

final

endpoint → String?

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

final

engineFamily → String?

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

final

hashCode → int

The hash code for this object.

no setter, inherited

idleClientTimeout → int?

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.

final

requireTLS → bool?

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

final

roleArn → String?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → DBProxyStatus?

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.

final

updatedDate → DateTime?

The date and time when the proxy was last updated.

final

vpcSecurityGroupIds → List<String>?

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

final

vpcSubnetIds → List<String>?

The EC2 subnet IDs for the proxy.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited