UpdateBackendAuthUserPoolConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplifybackend.model.UpdateBackendAuthUserPoolConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateBackendAuthUserPoolConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateBackendAuthUserPoolConfig()

Constructors
Constructor and Description
`UpdateBackendAuthUserPoolConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateBackendAuthUserPoolConfig`	`clone()`
`boolean`	`equals(Object obj)`
`UpdateBackendAuthForgotPasswordConfig`	`getForgotPassword()` (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthMFAConfig`	`getMfa()` Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
`UpdateBackendAuthOAuthConfig`	`getOAuth()` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthPasswordPolicyConfig`	`getPasswordPolicy()` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthVerificationMessageConfig`	`getVerificationMessage()` Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setForgotPassword(UpdateBackendAuthForgotPasswordConfig forgotPassword)` (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setMfa(UpdateBackendAuthMFAConfig mfa)` Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
`void`	`setOAuth(UpdateBackendAuthOAuthConfig oAuth)` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setPasswordPolicy(UpdateBackendAuthPasswordPolicyConfig passwordPolicy)` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setVerificationMessage(UpdateBackendAuthVerificationMessageConfig verificationMessage)` Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
`String`	`toString()` Returns a string representation of this object.
`UpdateBackendAuthUserPoolConfig`	`withForgotPassword(UpdateBackendAuthForgotPasswordConfig forgotPassword)` (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthUserPoolConfig`	`withMfa(UpdateBackendAuthMFAConfig mfa)` Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
`UpdateBackendAuthUserPoolConfig`	`withOAuth(UpdateBackendAuthOAuthConfig oAuth)` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthUserPoolConfig`	`withPasswordPolicy(UpdateBackendAuthPasswordPolicyConfig passwordPolicy)` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`UpdateBackendAuthUserPoolConfig`	`withVerificationMessage(UpdateBackendAuthVerificationMessageConfig verificationMessage)` Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

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

- Constructor Detail
  - UpdateBackendAuthUserPoolConfig
```
public UpdateBackendAuthUserPoolConfig()
```
- Method Detail
  - setForgotPassword
```
public void setForgotPassword(UpdateBackendAuthForgotPasswordConfig forgotPassword)
```
    (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    forgotPassword - (DEPRECATED)
  - getForgotPassword
```
public UpdateBackendAuthForgotPasswordConfig getForgotPassword()
```
    (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    (DEPRECATED)
  - withForgotPassword
```
public UpdateBackendAuthUserPoolConfig withForgotPassword(UpdateBackendAuthForgotPasswordConfig forgotPassword)
```
    (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    forgotPassword - (DEPRECATED)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMfa
```
public void setMfa(UpdateBackendAuthMFAConfig mfa)
```
    Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    
    Parameters:
    
    mfa - Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
  - getMfa
```
public UpdateBackendAuthMFAConfig getMfa()
```
    Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    
    Returns:
    
    Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
  - withMfa
```
public UpdateBackendAuthUserPoolConfig withMfa(UpdateBackendAuthMFAConfig mfa)
```
    Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    
    Parameters:
    
    mfa - Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOAuth
```
public void setOAuth(UpdateBackendAuthOAuthConfig oAuth)
```
    Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    oAuth - Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - getOAuth
```
public UpdateBackendAuthOAuthConfig getOAuth()
```
    Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - withOAuth
```
public UpdateBackendAuthUserPoolConfig withOAuth(UpdateBackendAuthOAuthConfig oAuth)
```
    Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    oAuth - Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPasswordPolicy
```
public void setPasswordPolicy(UpdateBackendAuthPasswordPolicyConfig passwordPolicy)
```
    Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    passwordPolicy - Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - getPasswordPolicy
```
public UpdateBackendAuthPasswordPolicyConfig getPasswordPolicy()
```
    Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - withPasswordPolicy
```
public UpdateBackendAuthUserPoolConfig withPasswordPolicy(UpdateBackendAuthPasswordPolicyConfig passwordPolicy)
```
    Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    passwordPolicy - Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVerificationMessage
```
public void setVerificationMessage(UpdateBackendAuthVerificationMessageConfig verificationMessage)
```
    Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    verificationMessage - Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - getVerificationMessage
```
public UpdateBackendAuthVerificationMessageConfig getVerificationMessage()
```
    Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - withVerificationMessage
```
public UpdateBackendAuthUserPoolConfig withVerificationMessage(UpdateBackendAuthVerificationMessageConfig verificationMessage)
```
    Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    verificationMessage - Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    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 UpdateBackendAuthUserPoolConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class UpdateBackendAuthUserPoolConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateBackendAuthUserPoolConfig

Method Detail

setForgotPassword

getForgotPassword

withForgotPassword

setMfa

getMfa

withMfa

setOAuth

getOAuth

withOAuth

setPasswordPolicy

getPasswordPolicy

withPasswordPolicy

setVerificationMessage

getVerificationMessage

withVerificationMessage

toString

equals

hashCode

clone

marshall