amplifybackend/aws.sdk.kotlin.services.amplifybackend.model/CreateBackendAuthUserPoolConfig

CreateBackendAuthUserPoolConfig

class CreateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

Types

Builder

class Builder

Companion

object Companion

Properties

forgotPassword

val forgotPassword: CreateBackendAuthForgotPasswordConfig?

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

mfa

val mfa: CreateBackendAuthMfaConfig?

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

oAuth

val oAuth: CreateBackendAuthOAuthConfig?

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

passwordPolicy

val passwordPolicy: CreateBackendAuthPasswordPolicyConfig?

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

requiredSignUpAttributes

val requiredSignUpAttributes: List<RequiredSignUpAttributesElement>?

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

signInMethod

val 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.

userPoolName

val userPoolName: String?

The Amazon Cognito user pool name.

verificationMessage

val verificationMessage: CreateBackendAuthVerificationMessageConfig?

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

Functions

copy

inline fun copy(block: CreateBackendAuthUserPoolConfig.Builder.() -> Unit = {}): CreateBackendAuthUserPoolConfig

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String