You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::NotifyConfigurationType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing NotifyConfigurationType as input to an Aws::Client method, you can use a vanilla Hash:

{
  from: "StringType",
  reply_to: "StringType",
  source_arn: "ArnType", # required
  block_email: {
    subject: "EmailNotificationSubjectType", # required
    html_body: "EmailNotificationBodyType",
    text_body: "EmailNotificationBodyType",
  },
  no_action_email: {
    subject: "EmailNotificationSubjectType", # required
    html_body: "EmailNotificationBodyType",
    text_body: "EmailNotificationBodyType",
  },
  mfa_email: {
    subject: "EmailNotificationSubjectType", # required
    html_body: "EmailNotificationBodyType",
    text_body: "EmailNotificationBodyType",
  },
}

The notify configuration type.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#block_email ⇒ Types::NotifyEmailType

Email template used when a detected risk event is blocked.

Returns:

#from ⇒ String

The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Returns:

  • (String) —

    The email address that is sending the email.

#mfa_email ⇒ Types::NotifyEmailType

The MFA email template used when MFA is challenged as part of a detected risk.

Returns:

#no_action_email ⇒ Types::NotifyEmailType

The email template used when a detected risk event is allowed.

Returns:

#reply_to ⇒ String

The destination to which the receiver of an email should reply to.

Returns:

  • (String) —

    The destination to which the receiver of an email should reply to.

#source_arn ⇒ String

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy.