Interface DBProxy.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DBProxy.Builder,
,DBProxy> SdkBuilder<DBProxy.Builder,
,DBProxy> SdkPojo
- Enclosing class:
DBProxy
-
Method Summary
Modifier and TypeMethodDescriptionauth
(Collection<UserAuthConfigInfo> auth) One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.auth
(Consumer<UserAuthConfigInfo.Builder>... auth) One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.auth
(UserAuthConfigInfo... auth) One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.createdDate
(Instant createdDate) The date and time when the proxy was first created.dbProxyArn
(String dbProxyArn) The Amazon Resource Name (ARN) for the proxy.dbProxyName
(String dbProxyName) The identifier for the proxy.debugLogging
(Boolean debugLogging) Indicates whether the proxy includes detailed information about SQL statements in its logs.The endpoint that you can use to connect to the DB proxy.engineFamily
(String engineFamily) The kinds of databases that the proxy can connect to.idleClientTimeout
(Integer idleClientTimeout) The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.requireTLS
(Boolean requireTLS) Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.The current status of this proxy.status
(DBProxyStatus status) The current status of this proxy.updatedDate
(Instant updatedDate) The date and time when the proxy was last updated.Provides the VPC ID of the DB proxy.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) Provides a list of VPC security groups that the proxy belongs to.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) Provides a list of VPC security groups that the proxy belongs to.vpcSubnetIds
(String... vpcSubnetIds) The EC2 subnet IDs for the proxy.vpcSubnetIds
(Collection<String> vpcSubnetIds) The EC2 subnet IDs for the proxy.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbProxyArn
The Amazon Resource Name (ARN) for the proxy.
- Parameters:
dbProxyArn
- The Amazon Resource Name (ARN) for the proxy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
status
- The current status of this proxy. A status ofavailable
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
status
- The current status of this proxy. A status ofavailable
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
Provides the VPC ID of the DB proxy.
- Parameters:
vpcId
- Provides the VPC ID of the DB proxy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
Provides a list of VPC security groups that the proxy belongs to.
- Parameters:
vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
Provides a list of VPC security groups that the proxy belongs to.
- Parameters:
vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSubnetIds
The EC2 subnet IDs for the proxy.
- Parameters:
vpcSubnetIds
- The EC2 subnet IDs for the proxy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSubnetIds
The EC2 subnet IDs for the proxy.
- Parameters:
vpcSubnetIds
- The EC2 subnet IDs for the proxy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
auth
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
- Parameters:
auth
- One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
auth
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
- Parameters:
auth
- One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
auth
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
This is a convenience method that creates an instance of theUserAuthConfigInfo.Builder
avoiding the need to create one manually viaUserAuthConfigInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauth(List<UserAuthConfigInfo>)
.- Parameters:
auth
- a consumer that will call methods onUserAuthConfigInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requireTLS
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
- Parameters:
requireTLS
- Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
debugLogging
Indicates 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.
- Parameters:
debugLogging
- Indicates 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdDate
The date and time when the proxy was first created.
- Parameters:
createdDate
- The date and time when the proxy was first created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedDate
The date and time when the proxy was last updated.
- Parameters:
updatedDate
- The date and time when the proxy was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-