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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#block_email ⇒ Types::NotifyEmailType

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

Returns:



8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end

#from ⇒ 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.

Returns:

  • (String) 


8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_email ⇒ Types::NotifyEmailType

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

Returns:



8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end

#no_action_email ⇒ Types::NotifyEmailType

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

Returns:



8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to ⇒ String

The reply-to email address of an email template.

Returns:

  • (String) 


8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

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:

  • (String) 


8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8538

class NotifyConfigurationType < Struct.new(
  :from,
  :reply_to,
  :source_arn,
  :block_email,
  :no_action_email,
  :mfa_email)
  SENSITIVE = []
  include Aws::Structure
end