Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class NotifyConfigurationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.NotifyConfigurationType

All Implemented Interfaces:

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

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

The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a Notify action.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NotifyConfigurationType.Builder

Method Summary

Modifier and Type	Method	Description
NotifyEmailType	blockEmail()	The template for the email message that your user pool sends when a detected risk event is blocked.
static NotifyConfigurationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	from()	The email address that sends the email message.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NotifyEmailType	mfaEmail()	The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
NotifyEmailType	noActionEmail()	The template for the email message that your user pool sends when no action is taken in response to a detected risk.
String	replyTo()	The reply-to email address of an email template.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NotifyConfigurationType.Builder>	serializableBuilderClass()
String	sourceArn()	The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy.
NotifyConfigurationType.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

from

public final String from()

The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

Returns:

The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

replyTo

public final String replyTo()

The reply-to email address of an email template.

Returns:

The reply-to email address of an email template.

sourceArn

public final String sourceArn()

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.

Returns:

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.

blockEmail

public final NotifyEmailType blockEmail()

The template for the email message that your user pool sends when a detected risk event is blocked.

Returns:

The template for the email message that your user pool sends when a detected risk event is blocked.

noActionEmail

public final NotifyEmailType noActionEmail()

The template for the email message that your user pool sends when no action is taken in response to a detected risk.

Returns:

The template for the email message that your user pool sends when no action is taken in response to a detected risk.

mfaEmail

public final NotifyEmailType mfaEmail()

The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.

Returns:

The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.

toBuilder

public NotifyConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotifyConfigurationType.Builder,NotifyConfigurationType>

builder

public static NotifyConfigurationType.Builder builder()

serializableBuilderClass

public static Class<? extends NotifyConfigurationType.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo