software.amazon.awssdk.services.rds.model

Class ModifyDbProxyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.ModifyDbProxyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyDbProxyRequest
extends RdsRequest
implements ToCopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyDbProxyRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<UserAuthConfig>	auth() The new authentication settings for the DBProxy.
static ModifyDbProxyRequest.Builder	builder()
String	dbProxyName() The identifier for the DBProxy to modify.
Boolean	debugLogging() Whether the proxy includes detailed information about SQL statements in its logs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuth() Returns true if the Auth property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSecurityGroups() Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	idleClientTimeout() The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
String	newDBProxyName() The new identifier for the DBProxy.
Boolean	requireTLS() Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups() The new list of security groups for the DBProxy.
static Class<? extends ModifyDbProxyRequest.Builder>	serializableBuilderClass()
ModifyDbProxyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbProxyName

public final String dbProxyName()

The identifier for the DBProxy to modify.

Returns:

The identifier for the DBProxy to modify.

newDBProxyName

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

Returns:

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.

hasAuth

public final boolean hasAuth()

Returns true if the Auth property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

auth

public final List<UserAuthConfig> auth()

The new authentication settings for the DBProxy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAuth() to see if a value was sent in this field.

Returns:

The new authentication settings for the DBProxy.

requireTLS

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

Returns:

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.

idleClientTimeout

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

Returns:

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.

debugLogging

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

Returns:

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.

roleArn

public final String roleArn()

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

Returns:

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

hasSecurityGroups

public final boolean hasSecurityGroups()

Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityGroups

public final List<String> securityGroups()

The new list of security groups for the DBProxy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSecurityGroups() to see if a value was sent in this field.

Returns:

The new list of security groups for the DBProxy.

toBuilder

public ModifyDbProxyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static ModifyDbProxyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyDbProxyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo