Class: Aws::AmplifyBackend::Types::CreateBackendAuthUserPoolConfig

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#forgot_password ⇒ Types::CreateBackendAuthForgotPasswordConfig

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

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#mfa ⇒ Types::CreateBackendAuthMFAConfig

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

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth ⇒ Types::CreateBackendAuthOAuthConfig

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

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#password_policy ⇒ Types::CreateBackendAuthPasswordPolicyConfig

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

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#required_sign_up_attributes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#sign_in_method ⇒ String

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:

  • (String) 


998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_name ⇒ String

The Amazon Cognito user pool name.

Returns:

  • (String) 


998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end

#verification_message ⇒ Types::CreateBackendAuthVerificationMessageConfig

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

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 998

class CreateBackendAuthUserPoolConfig < Struct.new(
  :forgot_password,
  :mfa,
  :o_auth,
  :password_policy,
  :required_sign_up_attributes,
  :sign_in_method,
  :user_pool_name,
  :verification_message)
  SENSITIVE = []
  include Aws::Structure
end