Class: Aws::AmplifyBackend::Types::CreateBackendAuthRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AmplifyBackend::Types::CreateBackendAuthRequest
- Defined in:
- gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb
Overview
Note:
When making an API call, you may pass CreateBackendAuthRequest data as a hash:
{
app_id: "__string", # required
backend_environment_name: "__string", # required
resource_config: { # required
auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
identity_pool_configs: {
identity_pool_name: "__string", # required
unauthenticated_login: false, # required
},
service: "COGNITO", # required, accepts COGNITO
user_pool_configs: { # required
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",
},
},
},
},
resource_name: "__string", # required
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#app_id ⇒ String
-
#backend_environment_name ⇒ String
-
#resource_config ⇒ Types::CreateBackendAuthResourceConfig
Defines the resource configuration when creating an auth resource in your Amplify project.
-
#resource_name ⇒ String
Instance Attribute Details
#app_id ⇒ String
1186 1187 1188 1189 1190 1191 1192 1193 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1186 class CreateBackendAuthRequest < Struct.new( :app_id, :backend_environment_name, :resource_config, :resource_name) SENSITIVE = [] include Aws::Structure end |
#backend_environment_name ⇒ String
1186 1187 1188 1189 1190 1191 1192 1193 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1186 class CreateBackendAuthRequest < Struct.new( :app_id, :backend_environment_name, :resource_config, :resource_name) SENSITIVE = [] include Aws::Structure end |
#resource_config ⇒ Types::CreateBackendAuthResourceConfig
Defines the resource configuration when creating an auth resource in your Amplify project.
1186 1187 1188 1189 1190 1191 1192 1193 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1186 class CreateBackendAuthRequest < Struct.new( :app_id, :backend_environment_name, :resource_config, :resource_name) SENSITIVE = [] include Aws::Structure end |
#resource_name ⇒ String
1186 1187 1188 1189 1190 1191 1192 1193 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1186 class CreateBackendAuthRequest < Struct.new( :app_id, :backend_environment_name, :resource_config, :resource_name) SENSITIVE = [] include Aws::Structure end |