Interface CreateDbProxyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbProxyRequest.Builder,CreateDbProxyRequest>, RdsRequest.Builder, SdkBuilder<CreateDbProxyRequest.Builder,CreateDbProxyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDbProxyRequest

public static interface CreateDbProxyRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbProxyRequest.Builder,CreateDbProxyRequest>
  • Method Details

    • dbProxyName

      CreateDbProxyRequest.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. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

      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. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • engineFamily

      CreateDbProxyRequest.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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

      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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • engineFamily

      CreateDbProxyRequest.Builder engineFamily(EngineFamily 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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

      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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • auth

      The authorization mechanism that the proxy uses.

      Parameters:
      auth - The authorization mechanism that the proxy uses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • auth

      The authorization mechanism that the proxy uses.

      Parameters:
      auth - The authorization mechanism that the proxy uses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • auth

      The authorization mechanism that the proxy uses.

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

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

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

      The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vpcSubnetIds

      CreateDbProxyRequest.Builder vpcSubnetIds(Collection<String> vpcSubnetIds)

      One or more VPC subnet IDs to associate with the new proxy.

      Parameters:
      vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vpcSubnetIds

      CreateDbProxyRequest.Builder vpcSubnetIds(String... vpcSubnetIds)

      One or more VPC subnet IDs to associate with the new proxy.

      Parameters:
      vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vpcSecurityGroupIds

      CreateDbProxyRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      One or more VPC security group IDs to associate with the new proxy.

      Parameters:
      vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vpcSecurityGroupIds

      CreateDbProxyRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      One or more VPC security group IDs to associate with the new proxy.

      Parameters:
      vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requireTLS

      CreateDbProxyRequest.Builder requireTLS(Boolean requireTLS)

      Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

      Parameters:
      requireTLS - Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • idleClientTimeout

      CreateDbProxyRequest.Builder idleClientTimeout(Integer idleClientTimeout)

      The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

      Parameters:
      idleClientTimeout - The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • debugLogging

      CreateDbProxyRequest.Builder debugLogging(Boolean debugLogging)

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

      An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

      Parameters:
      tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

      Parameters:
      tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

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

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

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

      CreateDbProxyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.