software.amazon.awssdk.services.amplifybackend.model

Class CreateBackendAuthForgotPasswordConfig

java.lang.Object

software.amazon.awssdk.services.amplifybackend.model.CreateBackendAuthForgotPasswordConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateBackendAuthForgotPasswordConfig.Builder,CreateBackendAuthForgotPasswordConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBackendAuthForgotPasswordConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateBackendAuthForgotPasswordConfig.Builder,CreateBackendAuthForgotPasswordConfig>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBackendAuthForgotPasswordConfig.Builder

Method Summary

Modifier and Type	Method and Description
static CreateBackendAuthForgotPasswordConfig.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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackendAuthForgotPasswordConfig.Builder>	serializableBuilderClass()
SmsSettings	smsSettings() The configuration for the SMS message sent when an app user forgets their password.
CreateBackendAuthForgotPasswordConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

deliveryMethod

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().

Returns:

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

See Also:

DeliveryMethod

deliveryMethodAsString

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().

Returns:

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

See Also:

DeliveryMethod

emailSettings

public final EmailSettings emailSettings()

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

Returns:

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

smsSettings

public final SmsSettings smsSettings()

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

Returns:

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

toBuilder

public CreateBackendAuthForgotPasswordConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackendAuthForgotPasswordConfig.Builder,CreateBackendAuthForgotPasswordConfig>

builder

public static CreateBackendAuthForgotPasswordConfig.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBackendAuthForgotPasswordConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo