@Generated(value="software.amazon.awssdk:codegen") public final class UpdateBackendAuthForgotPasswordConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpdateBackendAuthForgotPasswordConfig.Builder,UpdateBackendAuthForgotPasswordConfig>
Describes the forgot password policy for authenticating into the Amplify app.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateBackendAuthForgotPasswordConfig.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateBackendAuthForgotPasswordConfig.Builder |
builder() |
DeliveryMethod |
deliveryMethod()
Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their
password.
|
String |
deliveryMethodAsString()
Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their
password.
|
EmailSettings |
emailSettings()
The configuration for the email sent when an app user forgets their password.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateBackendAuthForgotPasswordConfig.Builder> |
serializableBuilderClass() |
SmsSettings |
smsSettings()
The configuration for the SMS message sent when an Amplify app user forgets their password.
|
UpdateBackendAuthForgotPasswordConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final DeliveryMethod deliveryMethod()
Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.
If the service returns an enum value that is not available in the current SDK version, deliveryMethod
will return DeliveryMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from deliveryMethodAsString()
.
DeliveryMethod
public final String deliveryMethodAsString()
Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.
If the service returns an enum value that is not available in the current SDK version, deliveryMethod
will return DeliveryMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from deliveryMethodAsString()
.
DeliveryMethod
public final EmailSettings emailSettings()
The configuration for the email sent when an app user forgets their password.
public final SmsSettings smsSettings()
The configuration for the SMS message sent when an Amplify app user forgets their password.
public UpdateBackendAuthForgotPasswordConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateBackendAuthForgotPasswordConfig.Builder,UpdateBackendAuthForgotPasswordConfig>
public static UpdateBackendAuthForgotPasswordConfig.Builder builder()
public static Class<? extends UpdateBackendAuthForgotPasswordConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()