Class: Aws::AmplifyBackend::Types::CreateBackendAuthForgotPasswordConfig

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 CreateBackendAuthForgotPasswordConfig data as a hash:

{
  delivery_method: "EMAIL", # required, accepts EMAIL, SMS
  email_settings: {
    email_message: "__string",
    email_subject: "__string",
  },
  sms_settings: {
    sms_message: "__string",
  },
}

Describes the forgot password policy for authenticating into the Amplify app.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_methodString

Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

Returns:

  • (String)


833
834
835
836
837
838
839
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 833

class CreateBackendAuthForgotPasswordConfig < Struct.new(
  :delivery_method,
  :email_settings,
  :sms_settings)
  SENSITIVE = []
  include Aws::Structure
end

#email_settingsTypes::EmailSettings

The configuration for the email sent when an app user forgets their password.



833
834
835
836
837
838
839
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 833

class CreateBackendAuthForgotPasswordConfig < Struct.new(
  :delivery_method,
  :email_settings,
  :sms_settings)
  SENSITIVE = []
  include Aws::Structure
end

#sms_settingsTypes::SmsSettings

The configuration for the SMS message sent when an app user forgets their password.

Returns:



833
834
835
836
837
838
839
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 833

class CreateBackendAuthForgotPasswordConfig < Struct.new(
  :delivery_method,
  :email_settings,
  :sms_settings)
  SENSITIVE = []
  include Aws::Structure
end