UserAuthConfigInfo (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserAuthConfigInfo
extends Object
implements Serializable, Cloneable
```
Returns 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

UserAuthConfigInfo()

Constructors
Constructor and Description
`UserAuthConfigInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserAuthConfigInfo`	`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`	`getDescription()` A user-specified description about the authentication used by a proxy to log in as a specific database user.
`String`	`getIAMAuth()` Whether to require or disallow AWS 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`	`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)` Whether to require or disallow AWS 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.
`UserAuthConfigInfo`	`withAuthScheme(AuthScheme authScheme)` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`UserAuthConfigInfo`	`withAuthScheme(String authScheme)` The type of authentication that the proxy uses for connections from the proxy to the underlying database.
`UserAuthConfigInfo`	`withDescription(String description)` A user-specified description about the authentication used by a proxy to log in as a specific database user.
`UserAuthConfigInfo`	`withIAMAuth(IAMAuthMode iAMAuth)` Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
`UserAuthConfigInfo`	`withIAMAuth(String iAMAuth)` Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
`UserAuthConfigInfo`	`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.
`UserAuthConfigInfo`	`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
  - UserAuthConfigInfo
```
public UserAuthConfigInfo()
```
- 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 UserAuthConfigInfo 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 UserAuthConfigInfo 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 UserAuthConfigInfo 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 UserAuthConfigInfo 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 UserAuthConfigInfo 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)
```
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Parameters:
    
    iAMAuth - Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    See Also:
    
    IAMAuthMode
  - getIAMAuth
```
public String getIAMAuth()
```
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Returns:
    
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    See Also:
    
    IAMAuthMode
  - withIAMAuth
```
public UserAuthConfigInfo withIAMAuth(String iAMAuth)
```
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Parameters:
    
    iAMAuth - Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IAMAuthMode
  - withIAMAuth
```
public UserAuthConfigInfo withIAMAuth(IAMAuthMode iAMAuth)
```
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Parameters:
    
    iAMAuth - Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IAMAuthMode
  - 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 UserAuthConfigInfo clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class UserAuthConfigInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserAuthConfigInfo

Method Detail

setDescription

getDescription

withDescription

setUserName

getUserName

withUserName

setAuthScheme

getAuthScheme

withAuthScheme

withAuthScheme

setSecretArn

getSecretArn

withSecretArn

setIAMAuth

getIAMAuth

withIAMAuth

withIAMAuth

toString

equals

hashCode

clone