Class: Aws::AmplifyBackend::Types::UpdateBackendAuthResourceConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::AmplifyBackend::Types::UpdateBackendAuthResourceConfig
- Defined in:
- gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb
Overview
When making an API call, you may pass UpdateBackendAuthResourceConfig data as a hash:
{
auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
identity_pool_configs: {
unauthenticated_login: false,
},
service: "COGNITO", # required, accepts COGNITO
user_pool_configs: { # required
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,
},
verification_message: {
delivery_method: "EMAIL", # required, accepts EMAIL, SMS
email_settings: {
email_message: "__string",
email_subject: "__string",
},
sms_settings: {
sms_message: "__string",
},
},
},
}
Defines the resource configuration when updating an authentication resource in your Amplify project.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#auth_resources ⇒ String
Defines the service name to use when configuring an authentication resource in your Amplify project.
-
#identity_pool_configs ⇒ Types::UpdateBackendAuthIdentityPoolConfig
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
-
#service ⇒ String
Defines the service name to use when configuring an authentication resource in your Amplify project.
-
#user_pool_configs ⇒ Types::UpdateBackendAuthUserPoolConfig
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
Instance Attribute Details
#auth_resources ⇒ String
Defines the service name to use when configuring an authentication resource in your Amplify project.
4368 4369 4370 4371 4372 4373 4374 4375 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 4368 class UpdateBackendAuthResourceConfig < Struct.new( :auth_resources, :identity_pool_configs, :service, :user_pool_configs) SENSITIVE = [] include Aws::Structure end |
#identity_pool_configs ⇒ Types::UpdateBackendAuthIdentityPoolConfig
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
4368 4369 4370 4371 4372 4373 4374 4375 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 4368 class UpdateBackendAuthResourceConfig < Struct.new( :auth_resources, :identity_pool_configs, :service, :user_pool_configs) SENSITIVE = [] include Aws::Structure end |
#service ⇒ String
Defines the service name to use when configuring an authentication resource in your Amplify project.
4368 4369 4370 4371 4372 4373 4374 4375 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 4368 class UpdateBackendAuthResourceConfig < Struct.new( :auth_resources, :identity_pool_configs, :service, :user_pool_configs) SENSITIVE = [] include Aws::Structure end |
#user_pool_configs ⇒ Types::UpdateBackendAuthUserPoolConfig
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
4368 4369 4370 4371 4372 4373 4374 4375 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 4368 class UpdateBackendAuthResourceConfig < Struct.new( :auth_resources, :identity_pool_configs, :service, :user_pool_configs) SENSITIVE = [] include Aws::Structure end |