ModifyDBProxyRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.rds.model

Class ModifyDBProxyRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.ModifyDBProxyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyDBProxyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ModifyDBProxyRequest ()

Constructors
Constructor and Description
`ModifyDBProxyRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ModifyDBProxyRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`List<UserAuthConfig>`	`getAuth ()` The new authentication settings for the `DBProxy`.
`String`	`getDBProxyName ()` The identifier for the `DBProxy` to modify.
`Boolean`	`getDebugLogging ()` Whether the proxy includes detailed information about SQL statements in its logs.
`Integer`	`getIdleClientTimeout ()` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`String`	`getNewDBProxyName ()` The new identifier for the `DBProxy`.
`Boolean`	`getRequireTLS ()` Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
`List<String>`	`getSecurityGroups ()` The new list of security groups for the `DBProxy`.
`int`	`hashCode ()`
`Boolean`	`isDebugLogging ()` Whether the proxy includes detailed information about SQL statements in its logs.
`Boolean`	`isRequireTLS ()` Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`void`	`setAuth (Collection<UserAuthConfig> auth)` The new authentication settings for the `DBProxy`.
`void`	`setDBProxyName (String dBProxyName)` The identifier for the `DBProxy` to modify.
`void`	`setDebugLogging (Boolean debugLogging)` Whether the proxy includes detailed information about SQL statements in its logs.
`void`	`setIdleClientTimeout (Integer idleClientTimeout)` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`void`	`setNewDBProxyName (String newDBProxyName)` The new identifier for the `DBProxy`.
`void`	`setRequireTLS (Boolean requireTLS)` Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
`void`	`setSecurityGroups (Collection<String> securityGroups)` The new list of security groups for the `DBProxy`.
`String`	`toString ()` Returns a string representation of this object.
`ModifyDBProxyRequest`	`withAuth (Collection<UserAuthConfig> auth)` The new authentication settings for the `DBProxy`.
`ModifyDBProxyRequest`	`withAuth (UserAuthConfig... auth)` The new authentication settings for the `DBProxy`.
`ModifyDBProxyRequest`	`withDBProxyName (String dBProxyName)` The identifier for the `DBProxy` to modify.
`ModifyDBProxyRequest`	`withDebugLogging (Boolean debugLogging)` Whether the proxy includes detailed information about SQL statements in its logs.
`ModifyDBProxyRequest`	`withIdleClientTimeout (Integer idleClientTimeout)` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`ModifyDBProxyRequest`	`withNewDBProxyName (String newDBProxyName)` The new identifier for the `DBProxy`.
`ModifyDBProxyRequest`	`withRequireTLS (Boolean requireTLS)` Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`ModifyDBProxyRequest`	`withRoleArn (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`	`withSecurityGroups (Collection<String> securityGroups)` The new list of security groups for the `DBProxy`.
`ModifyDBProxyRequest`	`withSecurityGroups (String... securityGroups)` The new list of security groups for the `DBProxy`.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ModifyDBProxyRequest
```
public ModifyDBProxyRequest()
```
- Method Detail
  - setDBProxyName
```
public void setDBProxyName(String dBProxyName)
```
    The identifier for the DBProxy to modify.
    
    Parameters:
    
    dBProxyName - The identifier for the DBProxy to modify.
  - getDBProxyName
```
public String getDBProxyName()
```
    The identifier for the DBProxy to modify.
    
    Returns:
    
    The identifier for the DBProxy to modify.
  - withDBProxyName
```
public ModifyDBProxyRequest withDBProxyName(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.
  - setNewDBProxyName
```
public void setNewDBProxyName(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.
  - getNewDBProxyName
```
public String getNewDBProxyName()
```
    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.
  - withNewDBProxyName
```
public ModifyDBProxyRequest withNewDBProxyName(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.
  - getAuth
```
public List<UserAuthConfig> getAuth()
```
    The new authentication settings for the DBProxy.
    
    Returns:
    
    The new authentication settings for the DBProxy.
  - setAuth
```
public void setAuth(Collection<UserAuthConfig> auth)
```
    The new authentication settings for the DBProxy.
    
    Parameters:
    
    auth - The new authentication settings for the DBProxy.
  - withAuth
```
public ModifyDBProxyRequest withAuth(UserAuthConfig... auth)
```
    The new authentication settings for the DBProxy.
    
    NOTE: This method appends the values to the existing list (if any). Use setAuth(java.util.Collection) or withAuth(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    auth - The new authentication settings for the DBProxy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAuth
```
public ModifyDBProxyRequest withAuth(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.
  - setRequireTLS
```
public void setRequireTLS(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.
  - getRequireTLS
```
public Boolean getRequireTLS()
```
    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.
  - withRequireTLS
```
public ModifyDBProxyRequest withRequireTLS(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.
  - isRequireTLS
```
public Boolean isRequireTLS()
```
    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.
  - setIdleClientTimeout
```
public void setIdleClientTimeout(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.
  - getIdleClientTimeout
```
public Integer getIdleClientTimeout()
```
    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.
  - withIdleClientTimeout
```
public ModifyDBProxyRequest withIdleClientTimeout(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.
  - setDebugLogging
```
public void setDebugLogging(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.
  - getDebugLogging
```
public Boolean getDebugLogging()
```
    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.
  - withDebugLogging
```
public ModifyDBProxyRequest withDebugLogging(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.
  - isDebugLogging
```
public Boolean isDebugLogging()
```
    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.
  - setRoleArn
```
public void setRoleArn(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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public ModifyDBProxyRequest withRoleArn(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.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    The new list of security groups for the DBProxy.
    
    Returns:
    
    The new list of security groups for the DBProxy.
  - setSecurityGroups
```
public void setSecurityGroups(Collection<String> securityGroups)
```
    The new list of security groups for the DBProxy.
    
    Parameters:
    
    securityGroups - The new list of security groups for the DBProxy.
  - withSecurityGroups
```
public ModifyDBProxyRequest withSecurityGroups(String... securityGroups)
```
    The new list of security groups for the DBProxy.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    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.
  - withSecurityGroups
```
public ModifyDBProxyRequest withSecurityGroups(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ModifyDBProxyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class ModifyDBProxyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ModifyDBProxyRequest

Method Detail

setDBProxyName

getDBProxyName

withDBProxyName

setNewDBProxyName

getNewDBProxyName

withNewDBProxyName

getAuth

setAuth

withAuth

withAuth

setRequireTLS

getRequireTLS

withRequireTLS

isRequireTLS

setIdleClientTimeout

getIdleClientTimeout

withIdleClientTimeout

setDebugLogging

getDebugLogging

withDebugLogging

isDebugLogging

setRoleArn

getRoleArn

withRoleArn

getSecurityGroups

setSecurityGroups

withSecurityGroups

withSecurityGroups

toString

equals

hashCode

clone