software.amazon.awssdk.services.rds.model

Interface ModifyDbProxyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>, RdsRequest.Builder, SdkBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyDbProxyRequest

public static interface ModifyDbProxyRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>

Method Summary

Modifier and Type	Method and Description
ModifyDbProxyRequest.Builder	auth(Collection<UserAuthConfig> auth) The new authentication settings for the DBProxy.
ModifyDbProxyRequest.Builder	auth(Consumer<UserAuthConfig.Builder>... auth) The new authentication settings for the DBProxy.
ModifyDbProxyRequest.Builder	auth(UserAuthConfig... auth) The new authentication settings for the DBProxy.
ModifyDbProxyRequest.Builder	dbProxyName(String dbProxyName) The identifier for the DBProxy to modify.
ModifyDbProxyRequest.Builder	debugLogging(Boolean debugLogging) Whether the proxy includes detailed information about SQL statements in its logs.
ModifyDbProxyRequest.Builder	idleClientTimeout(Integer idleClientTimeout) The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
ModifyDbProxyRequest.Builder	newDBProxyName(String newDBProxyName) The new identifier for the DBProxy.
ModifyDbProxyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ModifyDbProxyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ModifyDbProxyRequest.Builder	requireTLS(Boolean requireTLS) Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
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.
ModifyDbProxyRequest.Builder	securityGroups(Collection<String> securityGroups) The new list of security groups for the DBProxy.
ModifyDbProxyRequest.Builder	securityGroups(String... securityGroups) The new list of security groups for the DBProxy.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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.

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

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:

#auth(java.util.Collection)

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)

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

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ModifyDbProxyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder