Class: Aws::AmplifyBackend::Types::UpdateBackendAuthUserPoolConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb

Overview

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,
  },
}

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#forgot_password ⇒ Types::UpdateBackendAuthForgotPasswordConfig

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

Returns:



3837
3838
3839
3840
3841
3842
3843
3844
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3837

class UpdateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy)
  SENSITIVE = []
  include Aws::Structure
end

#mfa ⇒ Types::UpdateBackendAuthMFAConfig

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

Returns:



3837
3838
3839
3840
3841
3842
3843
3844
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3837

class UpdateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth ⇒ Types::UpdateBackendAuthOAuthConfig

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

Returns:



3837
3838
3839
3840
3841
3842
3843
3844
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3837

class UpdateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy)
  SENSITIVE = []
  include Aws::Structure
end

#password_policy ⇒ Types::UpdateBackendAuthPasswordPolicyConfig

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

Returns:



3837
3838
3839
3840
3841
3842
3843
3844
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3837

class UpdateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy)
  SENSITIVE = []
  include Aws::Structure
end