CreateBackendAuthUserPoolConfig (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateBackendAuthUserPoolConfig()

Constructors
Constructor and Description
`CreateBackendAuthUserPoolConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBackendAuthUserPoolConfig`	`clone()`
`boolean`	`equals(Object obj)`
`CreateBackendAuthForgotPasswordConfig`	`getForgotPassword()` Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`CreateBackendAuthMFAConfig`	`getMfa()` Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
`CreateBackendAuthOAuthConfig`	`getOAuth()` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`CreateBackendAuthPasswordPolicyConfig`	`getPasswordPolicy()` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`List<String>`	`getRequiredSignUpAttributes()` The required attributes to sign up new users in the Amazon Cognito user pool.
`String`	`getSignInMethod()` Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
`String`	`getUserPoolName()` The Amazon Cognito user pool name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setForgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)` Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setMfa(CreateBackendAuthMFAConfig mfa)` Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
`void`	`setOAuth(CreateBackendAuthOAuthConfig oAuth)` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setPasswordPolicy(CreateBackendAuthPasswordPolicyConfig passwordPolicy)` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`void`	`setRequiredSignUpAttributes(Collection<String> requiredSignUpAttributes)` The required attributes to sign up new users in the Amazon Cognito user pool.
`void`	`setSignInMethod(String signInMethod)` Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
`void`	`setUserPoolName(String userPoolName)` The Amazon Cognito user pool name.
`String`	`toString()` Returns a string representation of this object.
`CreateBackendAuthUserPoolConfig`	`withForgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)` Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withMfa(CreateBackendAuthMFAConfig mfa)` Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withOAuth(CreateBackendAuthOAuthConfig oAuth)` Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withPasswordPolicy(CreateBackendAuthPasswordPolicyConfig passwordPolicy)` Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withRequiredSignUpAttributes(Collection<String> requiredSignUpAttributes)` The required attributes to sign up new users in the Amazon Cognito user pool.
`CreateBackendAuthUserPoolConfig`	`withRequiredSignUpAttributes(RequiredSignUpAttributesElement... requiredSignUpAttributes)` The required attributes to sign up new users in the Amazon Cognito user pool.
`CreateBackendAuthUserPoolConfig`	`withRequiredSignUpAttributes(String... requiredSignUpAttributes)` The required attributes to sign up new users in the Amazon Cognito user pool.
`CreateBackendAuthUserPoolConfig`	`withSignInMethod(SignInMethod signInMethod)` Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withSignInMethod(String signInMethod)` Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
`CreateBackendAuthUserPoolConfig`	`withUserPoolName(String userPoolName)` The Amazon Cognito user pool name.

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

- Constructor Detail
  - CreateBackendAuthUserPoolConfig
```
public CreateBackendAuthUserPoolConfig()
```
- Method Detail
  - setForgotPassword
```
public void setForgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)
```
    Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    forgotPassword - Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - getForgotPassword
```
public CreateBackendAuthForgotPasswordConfig getForgotPassword()
```
    Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Returns:
    
    Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  - withForgotPassword
```
public CreateBackendAuthUserPoolConfig withForgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)
```
    Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    
    Parameters:
    
    forgotPassword - Describes the forgotten 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.
  - setMfa
```
public void setMfa(CreateBackendAuthMFAConfig mfa)
```
    Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Parameters:
    
    mfa - Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
  - getMfa
```
public CreateBackendAuthMFAConfig getMfa()
```
    Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Returns:
    
    Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
  - withMfa
```
public CreateBackendAuthUserPoolConfig withMfa(CreateBackendAuthMFAConfig mfa)
```
    Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Parameters:
    
    mfa - Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's 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(CreateBackendAuthOAuthConfig 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 CreateBackendAuthOAuthConfig 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 CreateBackendAuthUserPoolConfig withOAuth(CreateBackendAuthOAuthConfig 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(CreateBackendAuthPasswordPolicyConfig 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 CreateBackendAuthPasswordPolicyConfig 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 CreateBackendAuthUserPoolConfig withPasswordPolicy(CreateBackendAuthPasswordPolicyConfig 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.
  - getRequiredSignUpAttributes
```
public List<String> getRequiredSignUpAttributes()
```
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Returns:
    
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    See Also:
    
    RequiredSignUpAttributesElement
  - setRequiredSignUpAttributes
```
public void setRequiredSignUpAttributes(Collection<String> requiredSignUpAttributes)
```
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Parameters:
    
    requiredSignUpAttributes - The required attributes to sign up new users in the Amazon Cognito user pool.
    
    See Also:
    
    RequiredSignUpAttributesElement
  - withRequiredSignUpAttributes
```
public CreateBackendAuthUserPoolConfig withRequiredSignUpAttributes(String... requiredSignUpAttributes)
```
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequiredSignUpAttributes(java.util.Collection) or withRequiredSignUpAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    requiredSignUpAttributes - The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequiredSignUpAttributesElement
  - withRequiredSignUpAttributes
```
public CreateBackendAuthUserPoolConfig withRequiredSignUpAttributes(Collection<String> requiredSignUpAttributes)
```
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Parameters:
    
    requiredSignUpAttributes - The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequiredSignUpAttributesElement
  - withRequiredSignUpAttributes
```
public CreateBackendAuthUserPoolConfig withRequiredSignUpAttributes(RequiredSignUpAttributesElement... requiredSignUpAttributes)
```
    The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Parameters:
    
    requiredSignUpAttributes - The required attributes to sign up new users in the Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequiredSignUpAttributesElement
  - setSignInMethod
```
public void setSignInMethod(String signInMethod)
```
    Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Parameters:
    
    signInMethod - Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    See Also:
    
    SignInMethod
  - getSignInMethod
```
public String getSignInMethod()
```
    Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Returns:
    
    Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    See Also:
    
    SignInMethod
  - withSignInMethod
```
public CreateBackendAuthUserPoolConfig withSignInMethod(String signInMethod)
```
    Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Parameters:
    
    signInMethod - Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SignInMethod
  - withSignInMethod
```
public CreateBackendAuthUserPoolConfig withSignInMethod(SignInMethod signInMethod)
```
    Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Parameters:
    
    signInMethod - Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SignInMethod
  - setUserPoolName
```
public void setUserPoolName(String userPoolName)
```
    The Amazon Cognito user pool name.
    
    Parameters:
    
    userPoolName - The Amazon Cognito user pool name.
  - getUserPoolName
```
public String getUserPoolName()
```
    The Amazon Cognito user pool name.
    
    Returns:
    
    The Amazon Cognito user pool name.
  - withUserPoolName
```
public CreateBackendAuthUserPoolConfig withUserPoolName(String userPoolName)
```
    The Amazon Cognito user pool name.
    
    Parameters:
    
    userPoolName - The Amazon Cognito user pool name.
    
    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 CreateBackendAuthUserPoolConfig 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.

Did this page help you?

Class CreateBackendAuthUserPoolConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateBackendAuthUserPoolConfig

Method Detail

setForgotPassword

getForgotPassword

withForgotPassword

setMfa

getMfa

withMfa

setOAuth

getOAuth

withOAuth

setPasswordPolicy

getPasswordPolicy

withPasswordPolicy

getRequiredSignUpAttributes

setRequiredSignUpAttributes

withRequiredSignUpAttributes

withRequiredSignUpAttributes

withRequiredSignUpAttributes

setSignInMethod

getSignInMethod

withSignInMethod

withSignInMethod

setUserPoolName

getUserPoolName

withUserPoolName

toString

equals

hashCode

clone

marshall