Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolRiskConfigurationAttachment

@Stability(Stable)
public static interface CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 NotifyConfigurationTypeProperty notifyConfigurationTypeProperty = NotifyConfigurationTypeProperty.builder()
         .sourceArn("sourceArn")
         // the properties below are optional
         .blockEmail(NotifyEmailTypeProperty.builder()
                 .subject("subject")
                 // the properties below are optional
                 .htmlBody("htmlBody")
                 .textBody("textBody")
                 .build())
         .from("from")
         .mfaEmail(NotifyEmailTypeProperty.builder()
                 .subject("subject")
                 // the properties below are optional
                 .htmlBody("htmlBody")
                 .textBody("textBody")
                 .build())
         .noActionEmail(NotifyEmailTypeProperty.builder()
                 .subject("subject")
                 // the properties below are optional
                 .htmlBody("htmlBody")
                 .textBody("textBody")
                 .build())
         .replyTo("replyTo")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Builder	A builder for CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty
static final class	CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Jsii$Proxy	An implementation for CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Builder	builder()
default Object	getBlockEmail()	The template for the email message that your user pool sends when a detected risk event is blocked.
default String	getFrom()	The email address that sends the email message.
default Object	getMfaEmail()	The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
default Object	getNoActionEmail()	The template for the email message that your user pool sends when no action is taken in response to a detected risk.
default String	getReplyTo()	The reply-to email address of an email template.
String	getSourceArn()	The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceArn

@Stability(Stable)
@NotNull
String getSourceArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-sourcearn

getBlockEmail

@Stability(Stable)
@Nullable
default Object getBlockEmail()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-blockemail

getFrom

@Stability(Stable)
@Nullable
default String getFrom()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-from

getMfaEmail

@Stability(Stable)
@Nullable
default Object getMfaEmail()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-mfaemail

getNoActionEmail

@Stability(Stable)
@Nullable
default Object getNoActionEmail()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-noactionemail

getReplyTo

@Stability(Stable)
@Nullable
default String getReplyTo()

The reply-to email address of an email template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype.html#cfn-cognito-userpoolriskconfigurationattachment-notifyconfigurationtype-replyto

builder

@Stability(Stable)
static CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Builder builder()

Returns:

a CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty.Builder of CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty