class Aws::AmplifyBackend::Types::CreateBackendAuthUserPoolConfig

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

@note When making an API call, you may pass CreateBackendAuthUserPoolConfig

data as a hash:

    {
      forgot_password: {
        delivery_method: "EMAIL", # required, accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
      mfa: {
        mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
        settings: {
          mfa_types: ["SMS"], # accepts SMS, TOTP
          sms_message: "__string",
        },
      },
      o_auth: {
        domain_prefix: "__string",
        o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
        o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
        redirect_sign_in_ur_is: ["__string"], # required
        redirect_sign_out_ur_is: ["__string"], # required
        social_provider_settings: {
          facebook: {
            client_id: "__string",
            client_secret: "__string",
          },
          google: {
            client_id: "__string",
            client_secret: "__string",
          },
          login_with_amazon: {
            client_id: "__string",
            client_secret: "__string",
          },
          sign_in_with_apple: {
            client_id: "__string",
            key_id: "__string",
            private_key: "__string",
            team_id: "__string",
          },
        },
      },
      password_policy: {
        additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
        minimum_length: 1.0, # required
      },
      required_sign_up_attributes: ["ADDRESS"], # required, accepts ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO
      sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
      user_pool_name: "__string", # required
    }

@!attribute [rw] forgot_password

Describes the forgotten password policy for your Amazon Cognito user
pool, configured as a part of your Amplify project.
@return [Types::CreateBackendAuthForgotPasswordConfig]

@!attribute [rw] mfa

Describes whether to apply multi-factor authentication policies for
your Amazon Cognito user pool configured as a part of your Amplify
project.
@return [Types::CreateBackendAuthMFAConfig]

@!attribute [rw] o_auth

Describes the OAuth policy and rules for your Amazon Cognito user
pool, configured as a part of your Amplify project.
@return [Types::CreateBackendAuthOAuthConfig]

@!attribute [rw] password_policy

Describes the password policy for your Amazon Cognito user pool,
configured as a part of your Amplify project.
@return [Types::CreateBackendAuthPasswordPolicyConfig]

@!attribute [rw] required_sign_up_attributes

The required attributes to sign up new users in the user pool.
@return [Array<String>]

@!attribute [rw] sign_in_method

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.
@return [String]

@!attribute [rw] user_pool_name

The Amazon Cognito user pool name.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthUserPoolConfig AWS API Documentation

Constants

SENSITIVE