SetRiskConfigurationRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.SetRiskConfigurationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class SetRiskConfigurationRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns key AdvancedSecurityMode.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SetRiskConfigurationRequest()

Constructors
Constructor and Description
`SetRiskConfigurationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`AccountTakeoverRiskConfigurationType`	`getAccountTakeoverRiskConfiguration()` The account takeover risk configuration.
`java.lang.String`	`getClientId()` The app client ID.
`CompromisedCredentialsRiskConfigurationType`	`getCompromisedCredentialsRiskConfiguration()` The compromised credentials risk configuration.
`RiskExceptionConfigurationType`	`getRiskExceptionConfiguration()` The configuration to override the risk decision.
`java.lang.String`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`void`	`setAccountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration)` The account takeover risk configuration.
`void`	`setClientId(java.lang.String clientId)` The app client ID.
`void`	`setCompromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration)` The compromised credentials risk configuration.
`void`	`setRiskExceptionConfiguration(RiskExceptionConfigurationType riskExceptionConfiguration)` The configuration to override the risk decision.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SetRiskConfigurationRequest`	`withAccountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration)` The account takeover risk configuration.
`SetRiskConfigurationRequest`	`withClientId(java.lang.String clientId)` The app client ID.
`SetRiskConfigurationRequest`	`withCompromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration)` The compromised credentials risk configuration.
`SetRiskConfigurationRequest`	`withRiskExceptionConfiguration(RiskExceptionConfigurationType riskExceptionConfiguration)` The configuration to override the risk decision.
`SetRiskConfigurationRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - SetRiskConfigurationRequest
```
public SetRiskConfigurationRequest()
```
- Method Detail
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
  - withUserPoolId
```
public SetRiskConfigurationRequest withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public java.lang.String getClientId()
```
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
  - withClientId
```
public SetRiskConfigurationRequest withClientId(java.lang.String clientId)
```
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.
    
    Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCompromisedCredentialsRiskConfiguration
```
public CompromisedCredentialsRiskConfigurationType getCompromisedCredentialsRiskConfiguration()
```
    The compromised credentials risk configuration.
    
    Returns:
    
    The compromised credentials risk configuration.
  - setCompromisedCredentialsRiskConfiguration
```
public void setCompromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration)
```
    The compromised credentials risk configuration.
    
    Parameters:
    
    compromisedCredentialsRiskConfiguration -
    The compromised credentials risk configuration.
  - withCompromisedCredentialsRiskConfiguration
```
public SetRiskConfigurationRequest withCompromisedCredentialsRiskConfiguration(CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration)
```
    The compromised credentials risk configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    compromisedCredentialsRiskConfiguration -
    The compromised credentials risk configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAccountTakeoverRiskConfiguration
```
public AccountTakeoverRiskConfigurationType getAccountTakeoverRiskConfiguration()
```
    The account takeover risk configuration.
    
    Returns:
    
    The account takeover risk configuration.
  - setAccountTakeoverRiskConfiguration
```
public void setAccountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration)
```
    The account takeover risk configuration.
    
    Parameters:
    
    accountTakeoverRiskConfiguration -
    The account takeover risk configuration.
  - withAccountTakeoverRiskConfiguration
```
public SetRiskConfigurationRequest withAccountTakeoverRiskConfiguration(AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration)
```
    The account takeover risk configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    accountTakeoverRiskConfiguration -
    The account takeover risk configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRiskExceptionConfiguration
```
public RiskExceptionConfigurationType getRiskExceptionConfiguration()
```
    The configuration to override the risk decision.
    
    Returns:
    
    The configuration to override the risk decision.
  - setRiskExceptionConfiguration
```
public void setRiskExceptionConfiguration(RiskExceptionConfigurationType riskExceptionConfiguration)
```
    The configuration to override the risk decision.
    
    Parameters:
    
    riskExceptionConfiguration -
    The configuration to override the risk decision.
  - withRiskExceptionConfiguration
```
public SetRiskConfigurationRequest withRiskExceptionConfiguration(RiskExceptionConfigurationType riskExceptionConfiguration)
```
    The configuration to override the risk decision.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    riskExceptionConfiguration -
    The configuration to override the risk decision.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class SetRiskConfigurationRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SetRiskConfigurationRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getCompromisedCredentialsRiskConfiguration

setCompromisedCredentialsRiskConfiguration

withCompromisedCredentialsRiskConfiguration

getAccountTakeoverRiskConfiguration

setAccountTakeoverRiskConfiguration

withAccountTakeoverRiskConfiguration

getRiskExceptionConfiguration

setRiskExceptionConfiguration

withRiskExceptionConfiguration

toString

hashCode

equals