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("software.amazon.awssdk:codegen") public final class ModifyDbProxyRequest extends RdsRequest implements ToCopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyDbProxyRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<UserAuthConfig>
auth()
The new authentication settings for theDBProxy
.static ModifyDbProxyRequest.Builder
builder()
String
dbProxyName()
The identifier for theDBProxy
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()
For responses, this returns true if the service returned a value for the Auth property.int
hashCode()
boolean
hasSecurityGroups()
For responses, this returns true if the service returned a value for the SecurityGroups property.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 theDBProxy
.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 Amazon Web Services Secrets Manager.List<SdkField<?>>
sdkFields()
List<String>
securityGroups()
The new list of security groups for theDBProxy
.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()
For responses, this returns true if the service returned a value for the Auth property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAuth()
method.- 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 Amazon Web Services Secrets Manager.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
-
hasSecurityGroups
public final boolean hasSecurityGroups()
For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecurityGroups()
method.- Returns:
- The new list of security groups for the
DBProxy
.
-
toBuilder
public ModifyDbProxyRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyDbProxyRequest.Builder,ModifyDbProxyRequest>
- Specified by:
toBuilder
in classRdsRequest
-
builder
public static ModifyDbProxyRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyDbProxyRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-