Interface DBProxy.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DBProxy.Builder,DBProxy>, SdkBuilder<DBProxy.Builder,DBProxy>, SdkPojo
Enclosing class:
DBProxy
@Mutable @NotThreadSafe public static interface DBProxy.Builder extends SdkPojo, CopyableBuilder<DBProxy.Builder,DBProxy>

  • Method Details

    • dbProxyName

      DBProxy.Builder dbProxyName(String 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

      DBProxy.Builder dbProxyArn(String 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

      DBProxy.Builder status(String 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DBProxy.Builder status(DBProxyStatus 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engineFamily

      DBProxy.Builder engineFamily(String 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

      DBProxy.Builder vpcId(String 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

      DBProxy.Builder vpcSecurityGroupIds(Collection<String> 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

      DBProxy.Builder vpcSecurityGroupIds(String... 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

      DBProxy.Builder vpcSubnetIds(Collection<String> 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

      DBProxy.Builder vpcSubnetIds(String... 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

      DBProxy.Builder auth(Collection<UserAuthConfigInfo> 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

      DBProxy.Builder auth(UserAuthConfigInfo... 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

      DBProxy.Builder 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.

      This is a convenience method that creates an instance of the UserAuthConfigInfo.Builder avoiding the need to create one manually via UserAuthConfigInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to auth(List<UserAuthConfigInfo>).

      Parameters:
      auth - a consumer that will call methods on UserAuthConfigInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      DBProxy.Builder roleArn(String 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

      DBProxy.Builder endpoint(String 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

      DBProxy.Builder requireTLS(Boolean 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

      DBProxy.Builder idleClientTimeout(Integer 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

      DBProxy.Builder debugLogging(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdDate

      DBProxy.Builder createdDate(Instant 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

      DBProxy.Builder updatedDate(Instant 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.

    • endpointNetworkType

      DBProxy.Builder endpointNetworkType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointNetworkType

      DBProxy.Builder endpointNetworkType(EndpointNetworkType 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetConnectionNetworkType

      DBProxy.Builder targetConnectionNetworkType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetConnectionNetworkType

      DBProxy.Builder targetConnectionNetworkType(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.

      Valid values:

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

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

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: