Package software.amazon.awssdk.services.rds.model

Interface DBProxy.Builder

    • Method Detail

      • 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:
        DBProxyStatus, DBProxyStatus

      • 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:
        DBProxyStatus, DBProxyStatus

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

      • 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)

        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

        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.