Package software.amazon.awssdk.services.amplifybackend.model

Interface CreateBackendAuthUserPoolConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>, SdkBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>, SdkPojo

Enclosing class:

CreateBackendAuthUserPoolConfig

public static interface CreateBackendAuthUserPoolConfig.Builder
extends SdkPojo, CopyableBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>

Method Summary

Modifier and Type	Method	Description
default CreateBackendAuthUserPoolConfig.Builder	forgotPassword(Consumer<CreateBackendAuthForgotPasswordConfig.Builder> forgotPassword)	(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	forgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)	(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
default CreateBackendAuthUserPoolConfig.Builder	mfa(Consumer<CreateBackendAuthMFAConfig.Builder> mfa)	Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	mfa(CreateBackendAuthMFAConfig mfa)	Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
default CreateBackendAuthUserPoolConfig.Builder	oAuth(Consumer<CreateBackendAuthOAuthConfig.Builder> oAuth)	Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	oAuth(CreateBackendAuthOAuthConfig oAuth)	Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
default CreateBackendAuthUserPoolConfig.Builder	passwordPolicy(Consumer<CreateBackendAuthPasswordPolicyConfig.Builder> passwordPolicy)	Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	passwordPolicy(CreateBackendAuthPasswordPolicyConfig passwordPolicy)	Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	requiredSignUpAttributes(Collection<RequiredSignUpAttributesElement> requiredSignUpAttributes)	The required attributes to sign up new users in the user pool.
CreateBackendAuthUserPoolConfig.Builder	requiredSignUpAttributes(RequiredSignUpAttributesElement... requiredSignUpAttributes)	The required attributes to sign up new users in the user pool.
CreateBackendAuthUserPoolConfig.Builder	requiredSignUpAttributesWithStrings(String... requiredSignUpAttributes)	The required attributes to sign up new users in the user pool.
CreateBackendAuthUserPoolConfig.Builder	requiredSignUpAttributesWithStrings(Collection<String> requiredSignUpAttributes)	The required attributes to sign up new users in the user pool.
CreateBackendAuthUserPoolConfig.Builder	signInMethod(String signInMethod)	Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	signInMethod(SignInMethod signInMethod)	Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	userPoolName(String userPoolName)	The Amazon Cognito user pool name.
default CreateBackendAuthUserPoolConfig.Builder	verificationMessage(Consumer<CreateBackendAuthVerificationMessageConfig.Builder> verificationMessage)	Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthUserPoolConfig.Builder	verificationMessage(CreateBackendAuthVerificationMessageConfig 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 interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

forgotPassword

CreateBackendAuthUserPoolConfig.Builder forgotPassword(CreateBackendAuthForgotPasswordConfig forgotPassword)

(DEPRECATED) Describes the forgotten 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.

forgotPassword

default CreateBackendAuthUserPoolConfig.Builder forgotPassword(Consumer<CreateBackendAuthForgotPasswordConfig.Builder> forgotPassword)

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

This is a convenience method that creates an instance of the CreateBackendAuthForgotPasswordConfig.Builder avoiding the need to create one manually via CreateBackendAuthForgotPasswordConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to forgotPassword(CreateBackendAuthForgotPasswordConfig).

Parameters:

forgotPassword - a consumer that will call methods on CreateBackendAuthForgotPasswordConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• forgotPassword(CreateBackendAuthForgotPasswordConfig)

mfa

CreateBackendAuthUserPoolConfig.Builder mfa(CreateBackendAuthMFAConfig 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.

mfa

default CreateBackendAuthUserPoolConfig.Builder mfa(Consumer<CreateBackendAuthMFAConfig.Builder> mfa)

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

This is a convenience method that creates an instance of the CreateBackendAuthMFAConfig.Builder avoiding the need to create one manually via CreateBackendAuthMFAConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mfa(CreateBackendAuthMFAConfig).

Parameters:

mfa - a consumer that will call methods on CreateBackendAuthMFAConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• mfa(CreateBackendAuthMFAConfig)

oAuth

CreateBackendAuthUserPoolConfig.Builder oAuth(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.

oAuth

default CreateBackendAuthUserPoolConfig.Builder oAuth(Consumer<CreateBackendAuthOAuthConfig.Builder> oAuth)

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

This is a convenience method that creates an instance of the CreateBackendAuthOAuthConfig.Builder avoiding the need to create one manually via CreateBackendAuthOAuthConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to oAuth(CreateBackendAuthOAuthConfig).

Parameters:

oAuth - a consumer that will call methods on CreateBackendAuthOAuthConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• oAuth(CreateBackendAuthOAuthConfig)

passwordPolicy

CreateBackendAuthUserPoolConfig.Builder passwordPolicy(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.

passwordPolicy

default CreateBackendAuthUserPoolConfig.Builder passwordPolicy(Consumer<CreateBackendAuthPasswordPolicyConfig.Builder> passwordPolicy)

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

This is a convenience method that creates an instance of the CreateBackendAuthPasswordPolicyConfig.Builder avoiding the need to create one manually via CreateBackendAuthPasswordPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to passwordPolicy(CreateBackendAuthPasswordPolicyConfig).

Parameters:

passwordPolicy - a consumer that will call methods on CreateBackendAuthPasswordPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• passwordPolicy(CreateBackendAuthPasswordPolicyConfig)

requiredSignUpAttributesWithStrings

CreateBackendAuthUserPoolConfig.Builder requiredSignUpAttributesWithStrings(Collection<String> requiredSignUpAttributes)

The required attributes to sign up new users in the user pool.

Parameters:

requiredSignUpAttributes - The required attributes to sign up new users in the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

requiredSignUpAttributesWithStrings

CreateBackendAuthUserPoolConfig.Builder requiredSignUpAttributesWithStrings(String... requiredSignUpAttributes)

The required attributes to sign up new users in the user pool.

Parameters:

requiredSignUpAttributes - The required attributes to sign up new users in the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

requiredSignUpAttributes

CreateBackendAuthUserPoolConfig.Builder requiredSignUpAttributes(Collection<RequiredSignUpAttributesElement> requiredSignUpAttributes)

The required attributes to sign up new users in the user pool.

Parameters:

requiredSignUpAttributes - The required attributes to sign up new users in the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

requiredSignUpAttributes

CreateBackendAuthUserPoolConfig.Builder requiredSignUpAttributes(RequiredSignUpAttributesElement... requiredSignUpAttributes)

The required attributes to sign up new users in the user pool.

Parameters:

requiredSignUpAttributes - The required attributes to sign up new users in the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

signInMethod

CreateBackendAuthUserPoolConfig.Builder signInMethod(String signInMethod)

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

Parameters:

signInMethod - Describes the sign-in methods that your Amplify app users use to log in using the 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.

See Also:

• SignInMethod
• SignInMethod

signInMethod

CreateBackendAuthUserPoolConfig.Builder signInMethod(SignInMethod signInMethod)

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

Parameters:

signInMethod - Describes the sign-in methods that your Amplify app users use to log in using the 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.

See Also:

• SignInMethod
• SignInMethod

userPoolName

CreateBackendAuthUserPoolConfig.Builder userPoolName(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.

verificationMessage

CreateBackendAuthUserPoolConfig.Builder verificationMessage(CreateBackendAuthVerificationMessageConfig 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.

verificationMessage

default CreateBackendAuthUserPoolConfig.Builder verificationMessage(Consumer<CreateBackendAuthVerificationMessageConfig.Builder> verificationMessage)

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

This is a convenience method that creates an instance of the CreateBackendAuthVerificationMessageConfig.Builder avoiding the need to create one manually via CreateBackendAuthVerificationMessageConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationMessage(CreateBackendAuthVerificationMessageConfig).

Parameters:

verificationMessage - a consumer that will call methods on CreateBackendAuthVerificationMessageConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• verificationMessage(CreateBackendAuthVerificationMessageConfig)