UserAuthConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rds.model.UserAuthConfig

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserAuthConfig
extends Object
implements Serializable, Cloneable
```
Specifies the details of authentication used by a proxy to log in as a specific database user.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserAuthConfig()

Constructors
Constructor and Description
`UserAuthConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserAuthConfig`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthScheme()` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`String`	`getClientPasswordAuthType()` The type of authentication the proxy uses for connections from clients.
`String`	`getDescription()` A user-specified description about the authentication used by a proxy to log in as a specific database user.
`String`	`getIAMAuth()` A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
`String`	`getUserName()` The name of the database user to which the proxy connects.
`int`	`hashCode()`
`void`	`setAuthScheme(String authScheme)` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`void`	`setClientPasswordAuthType(String clientPasswordAuthType)` The type of authentication the proxy uses for connections from clients.
`void`	`setDescription(String description)` A user-specified description about the authentication used by a proxy to log in as a specific database user.
`void`	`setIAMAuth(String iAMAuth)` A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
`void`	`setUserName(String userName)` The name of the database user to which the proxy connects.
`String`	`toString()` Returns a string representation of this object.
`UserAuthConfig`	`withAuthScheme(AuthScheme authScheme)` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`UserAuthConfig`	`withAuthScheme(String authScheme)` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`UserAuthConfig`	`withClientPasswordAuthType(ClientPasswordAuthType clientPasswordAuthType)` The type of authentication the proxy uses for connections from clients.
`UserAuthConfig`	`withClientPasswordAuthType(String clientPasswordAuthType)` The type of authentication the proxy uses for connections from clients.
`UserAuthConfig`	`withDescription(String description)` A user-specified description about the authentication used by a proxy to log in as a specific database user.
`UserAuthConfig`	`withIAMAuth(IAMAuthMode iAMAuth)` A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
`UserAuthConfig`	`withIAMAuth(String iAMAuth)` A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
`UserAuthConfig`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
`UserAuthConfig`	`withUserName(String userName)` The name of the database user to which the proxy connects.

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

- Constructor Detail
  - UserAuthConfig
```
public UserAuthConfig()
```
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    
    Parameters:
    
    description - A user-specified description about the authentication used by a proxy to log in as a specific database user.
  - getDescription
```
public String getDescription()
```
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    
    Returns:
    
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
  - withDescription
```
public UserAuthConfig withDescription(String description)
```
    A user-specified description about the authentication used by a proxy to log in as a specific database user.
    
    Parameters:
    
    description - A user-specified description about the authentication used by a proxy to log in as a specific database user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The name of the database user to which the proxy connects.
    
    Parameters:
    
    userName - The name of the database user to which the proxy connects.
  - getUserName
```
public String getUserName()
```
    The name of the database user to which the proxy connects.
    
    Returns:
    
    The name of the database user to which the proxy connects.
  - withUserName
```
public UserAuthConfig withUserName(String userName)
```
    The name of the database user to which the proxy connects.
    
    Parameters:
    
    userName - The name of the database user to which the proxy connects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthScheme
```
public void setAuthScheme(String authScheme)
```
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Parameters:
    
    authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    See Also:
    
    AuthScheme
  - getAuthScheme
```
public String getAuthScheme()
```
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Returns:
    
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    See Also:
    
    AuthScheme
  - withAuthScheme
```
public UserAuthConfig withAuthScheme(String authScheme)
```
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Parameters:
    
    authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthScheme
  - withAuthScheme
```
public UserAuthConfig withAuthScheme(AuthScheme authScheme)
```
    The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Parameters:
    
    authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthScheme
  - setSecretArn
```
public void setSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
  - getSecretArn
```
public String getSecretArn()
```
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    
    Returns:
    
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
  - withSecretArn
```
public UserAuthConfig withSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIAMAuth
```
public void setIAMAuth(String iAMAuth)
```
    A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Parameters:
    
    iAMAuth - A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    See Also:
    
    IAMAuthMode
  - getIAMAuth
```
public String getIAMAuth()
```
    A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Returns:
    
    A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    See Also:
    
    IAMAuthMode
  - withIAMAuth
```
public UserAuthConfig withIAMAuth(String iAMAuth)
```
    A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Parameters:
    
    iAMAuth - A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IAMAuthMode
  - withIAMAuth
```
public UserAuthConfig withIAMAuth(IAMAuthMode iAMAuth)
```
    A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Parameters:
    
    iAMAuth - A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IAMAuthMode
  - setClientPasswordAuthType
```
public void setClientPasswordAuthType(String clientPasswordAuthType)
```
    The type of authentication the proxy uses for connections from clients.
    
    Parameters:
    
    clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.
    
    See Also:
    
    ClientPasswordAuthType
  - getClientPasswordAuthType
```
public String getClientPasswordAuthType()
```
    The type of authentication the proxy uses for connections from clients.
    
    Returns:
    
    The type of authentication the proxy uses for connections from clients.
    
    See Also:
    
    ClientPasswordAuthType
  - withClientPasswordAuthType
```
public UserAuthConfig withClientPasswordAuthType(String clientPasswordAuthType)
```
    The type of authentication the proxy uses for connections from clients.
    
    Parameters:
    
    clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClientPasswordAuthType
  - withClientPasswordAuthType
```
public UserAuthConfig withClientPasswordAuthType(ClientPasswordAuthType clientPasswordAuthType)
```
    The type of authentication the proxy uses for connections from clients.
    
    Parameters:
    
    clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClientPasswordAuthType
  - 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 UserAuthConfig clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class UserAuthConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserAuthConfig

Method Detail

setDescription

getDescription

withDescription

setUserName

getUserName

withUserName

setAuthScheme

getAuthScheme

withAuthScheme

withAuthScheme

setSecretArn

getSecretArn

withSecretArn

setIAMAuth

getIAMAuth

withIAMAuth

withIAMAuth

setClientPasswordAuthType

getClientPasswordAuthType

withClientPasswordAuthType

withClientPasswordAuthType

toString

equals

hashCode

clone