Interface ModifyDbProxyRequest.Builder

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

  • Method Details

    • dbProxyName

      ModifyDbProxyRequest.Builder dbProxyName(String dbProxyName)

      The identifier for the DBProxy to modify.

      Parameters:
      dbProxyName - The identifier for the DBProxy to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newDBProxyName

      ModifyDbProxyRequest.Builder newDBProxyName(String newDBProxyName)

      The new identifier for the DBProxy. 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:
      newDBProxyName - The new identifier for the DBProxy. 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.

    • defaultAuthScheme

      ModifyDbProxyRequest.Builder defaultAuthScheme(String defaultAuthScheme)

      The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

      Parameters:
      defaultAuthScheme - The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultAuthScheme

      ModifyDbProxyRequest.Builder defaultAuthScheme(DefaultAuthScheme defaultAuthScheme)

      The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

      Parameters:
      defaultAuthScheme - The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • auth

      ModifyDbProxyRequest.Builder auth(Collection<UserAuthConfig> auth)

      The new authentication settings for the DBProxy.

      Parameters:
      auth - The new authentication settings for the DBProxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auth

      ModifyDbProxyRequest.Builder auth(UserAuthConfig... auth)

      The new authentication settings for the DBProxy.

      Parameters:
      auth - The new authentication settings for the DBProxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auth

      ModifyDbProxyRequest.Builder auth(Consumer<UserAuthConfig.Builder>... auth)

      The new authentication settings for the DBProxy.

      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:

    • requireTLS

      ModifyDbProxyRequest.Builder requireTLS(Boolean requireTLS)

      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, even if the associated database doesn't use TLS.

      Parameters:
      requireTLS - 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, even if the associated database doesn't use TLS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idleClientTimeout

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

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

    • roleArn

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

    • securityGroups

      ModifyDbProxyRequest.Builder securityGroups(Collection<String> securityGroups)

      The new list of security groups for the DBProxy.

      Parameters:
      securityGroups - The new list of security groups for the DBProxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      ModifyDbProxyRequest.Builder securityGroups(String... securityGroups)

      The new list of security groups for the DBProxy.

      Parameters:
      securityGroups - The new list of security groups for the DBProxy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

      ModifyDbProxyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.