Skip to content
v2.278.0

NotifyConfigurationTypeProperty Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const notifyConfigurationTypeProperty: cognito.CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty = {
  sourceArn: 'sourceArn',

  // the properties below are optional
  blockEmail: {
    subject: 'subject',

    // the properties below are optional
    htmlBody: 'htmlBody',
    textBody: 'textBody',
  },
  from: 'from',
  mfaEmail: {
    subject: 'subject',

    // the properties below are optional
    htmlBody: 'htmlBody',
    textBody: 'textBody',
  },
  noActionEmail: {
    subject: 'subject',

    // the properties below are optional
    htmlBody: 'htmlBody',
    textBody: 'textBody',
  },
  replyTo: 'replyTo',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

notify_configuration_type_property = cognito.CfnUserPoolRiskConfigurationAttachment.NotifyConfigurationTypeProperty(
    source_arn="sourceArn",

    # the properties below are optional
    block_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
        subject="subject",

        # the properties below are optional
        html_body="htmlBody",
        text_body="textBody"
    ),
    from="from",
    mfa_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
        subject="subject",

        # the properties below are optional
        html_body="htmlBody",
        text_body="textBody"
    ),
    no_action_email=cognito.CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypeProperty(
        subject="subject",

        # the properties below are optional
        html_body="htmlBody",
        text_body="textBody"
    ),
    reply_to="replyTo"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;

var notifyConfigurationTypeProperty = new NotifyConfigurationTypeProperty {
    SourceArn = "sourceArn",

    // the properties below are optional
    BlockEmail = new NotifyEmailTypeProperty {
        Subject = "subject",

        // the properties below are optional
        HtmlBody = "htmlBody",
        TextBody = "textBody"
    },
    From = "from",
    MfaEmail = new NotifyEmailTypeProperty {
        Subject = "subject",

        // the properties below are optional
        HtmlBody = "htmlBody",
        TextBody = "textBody"
    },
    NoActionEmail = new NotifyEmailTypeProperty {
        Subject = "subject",

        // the properties below are optional
        HtmlBody = "htmlBody",
        TextBody = "textBody"
    },
    ReplyTo = "replyTo"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

notifyConfigurationTypeProperty := &NotifyConfigurationTypeProperty{
	SourceArn: jsii.String("sourceArn"),

	// the properties below are optional
	BlockEmail: &NotifyEmailTypeProperty{
		Subject: jsii.String("subject"),

		// the properties below are optional
		HtmlBody: jsii.String("htmlBody"),
		TextBody: jsii.String("textBody"),
	},
	From: jsii.String("from"),
	MfaEmail: &NotifyEmailTypeProperty{
		Subject: jsii.String("subject"),

		// the properties below are optional
		HtmlBody: jsii.String("htmlBody"),
		TextBody: jsii.String("textBody"),
	},
	NoActionEmail: &NotifyEmailTypeProperty{
		Subject: jsii.String("subject"),

		// the properties below are optional
		HtmlBody: jsii.String("htmlBody"),
		TextBody: jsii.String("textBody"),
	},
	ReplyTo: jsii.String("replyTo"),
}

Properties ​

blockEmailoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypePropertyblock_emailoptionaltyping.Union[IResolvable, NotifyEmailTypeProperty]blockEmailoptionalIResolvableBlockEmailoptionalIResolvableBlockEmailoptionalinterface{} #
The template for the email message that your user pool sends when a detected risk event is blocked.
fromoptionalstringfromoptionalstrfromoptionalStringFromoptionalstringFromoptional*string #
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.

mfaEmailoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypePropertymfa_emailoptionaltyping.Union[IResolvable, NotifyEmailTypeProperty]mfaEmailoptionalIResolvableMfaEmailoptionalIResolvableMfaEmailoptionalinterface{} #
The template for the email message that your user pool sends when MFA is challenged in response to a detected risk.
noActionEmailoptionalIResolvable | CfnUserPoolRiskConfigurationAttachment.NotifyEmailTypePropertyno_action_emailoptionaltyping.Union[IResolvable, NotifyEmailTypeProperty]noActionEmailoptionalIResolvableNoActionEmailoptionalIResolvableNoActionEmailoptionalinterface{} #
The template for the email message that your user pool sends when no action is taken in response to a detected risk.
replyTooptionalstringreply_tooptionalstrreplyTooptionalStringReplyTooptionalstringReplyTooptional*string #
The reply-to email address of an email template.

Can be an email address in the format admin@example.com or Administrator <admin@example.com> .

sourceArnstringsource_arnstrsourceArnStringSourceArnstringSourceArn*string required #
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.