class Aws::AmplifyBackend::Types::UpdateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

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

data as a hash:

    {
      forgot_password: {
        delivery_method: "EMAIL", # accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
      mfa: {
        mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
        settings: {
          mfa_types: ["SMS"], # accepts SMS, TOTP
          sms_message: "__string",
        },
      },
      o_auth: {
        domain_prefix: "__string",
        o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
        o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
        redirect_sign_in_ur_is: ["__string"],
        redirect_sign_out_ur_is: ["__string"],
        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,
      },
    }

@!attribute [rw] forgot_password

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

@!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::UpdateBackendAuthMFAConfig]

@!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::UpdateBackendAuthOAuthConfig]

@!attribute [rw] password_policy

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

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

Constants

SENSITIVE