rds/aws.sdk.kotlin.services.rds.model/DbProxy/Builder

Builder

Properties

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

createdDate

var createdDate: Instant?

The date and time when the proxy was first created.

dbProxyArn

var dbProxyArn: String?

The Amazon Resource Name (ARN) for the proxy.

dbProxyName

var dbProxyName: String?

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.

debugLogging

var debugLogging: Boolean?

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.

endpoint

var endpoint: String?

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.

endpointNetworkType

var endpointNetworkType: EndpointNetworkType?

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

engineFamily

var engineFamily: String?

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.

idleClientTimeout

var 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.

requireTls

var requireTls: Boolean?

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

roleArn

var roleArn: String?

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

status

var 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.

targetConnectionNetworkType

var targetConnectionNetworkType: 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.

updatedDate

var updatedDate: Instant?

The date and time when the proxy was last updated.

vpcId

var vpcId: String?

Provides the VPC ID of the DB proxy.

vpcSecurityGroupIds

var vpcSecurityGroupIds: List<String>?

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

vpcSubnetIds

var vpcSubnetIds: List<String>?

The EC2 subnet IDs for the proxy.