Class: Aws::AmplifyBackend::Types::CreateBackendAuthUserPoolConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::AmplifyBackend::Types::CreateBackendAuthUserPoolConfig
- Defined in:
- gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb
Overview
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
verification_message: {
delivery_method: "EMAIL", # required, accepts EMAIL, SMS
email_settings: {
email_message: "__string",
email_subject: "__string",
},
sms_settings: {
sms_message: "__string",
},
},
}
Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#forgot_password ⇒ Types::CreateBackendAuthForgotPasswordConfig
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
-
#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.
-
#o_auth ⇒ Types::CreateBackendAuthOAuthConfig
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
-
#password_policy ⇒ Types::CreateBackendAuthPasswordPolicyConfig
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
-
#required_sign_up_attributes ⇒ Array<String>
The required attributes to sign up new users in the user pool.
-
#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.
-
#user_pool_name ⇒ String
The Amazon Cognito user pool name.
-
#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.
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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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.
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1450 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 |