Class: AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::NotifyConfigurationTypeProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_user_pool_risk_configuration_attachment.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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_arn:, block_email: nil, from: nil, mfa_email: nil, no_action_email: nil, reply_to: nil) ⇒ NotifyConfigurationTypeProperty

Returns a new instance of NotifyConfigurationTypeProperty.

Parameters:



782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 782

def initialize(source_arn:, block_email: nil, from: nil, mfa_email: nil, no_action_email: nil, reply_to: nil)
  @source_arn = source_arn
  Jsii::Type.check_type(@source_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceArn")
  @block_email = block_email.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::NotifyEmailTypeProperty.new(**block_email.transform_keys(&:to_sym)) : block_email
  Jsii::Type.check_type(@block_email, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50Lk5vdGlmeUVtYWlsVHlwZVByb3BlcnR5In1dfX0=")), "blockEmail") unless @block_email.nil?
  @from = from
  Jsii::Type.check_type(@from, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "from") unless @from.nil?
  @mfa_email = mfa_email.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::NotifyEmailTypeProperty.new(**mfa_email.transform_keys(&:to_sym)) : mfa_email
  Jsii::Type.check_type(@mfa_email, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50Lk5vdGlmeUVtYWlsVHlwZVByb3BlcnR5In1dfX0=")), "mfaEmail") unless @mfa_email.nil?
  @no_action_email = no_action_email.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::NotifyEmailTypeProperty.new(**no_action_email.transform_keys(&:to_sym)) : no_action_email
  Jsii::Type.check_type(@no_action_email, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sUmlza0NvbmZpZ3VyYXRpb25BdHRhY2htZW50Lk5vdGlmeUVtYWlsVHlwZVByb3BlcnR5In1dfX0=")), "noActionEmail") unless @no_action_email.nil?
  @reply_to = reply_to
  Jsii::Type.check_type(@reply_to, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replyTo") unless @reply_to.nil?
end

Instance Attribute Details

#block_email ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



808
809
810
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 808

def block_email
  @block_email
end

#from ⇒ String? (readonly)

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, nil)

See Also:



815
816
817
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 815

def from
  @from
end

#mfa_email ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



820
821
822
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 820

def mfa_email
  @mfa_email
end

#no_action_email ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



825
826
827
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 825

def no_action_email
  @no_action_email
end

#reply_to ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



832
833
834
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 832

def reply_to
  @reply_to
end

#source_arn ⇒ String (readonly)

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)

See Also:



803
804
805
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 803

def source_arn
  @source_arn
end

Class Method Details

.jsii_properties ⇒ Object 



834
835
836
837
838
839
840
841
842
843
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 834

def self.jsii_properties
  {
    :source_arn => "sourceArn",
    :block_email => "blockEmail",
    :from => "from",
    :mfa_email => "mfaEmail",
    :no_action_email => "noActionEmail",
    :reply_to => "replyTo",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 845

def to_jsii
  result = {}
  result.merge!({
    "sourceArn" => @source_arn,
    "blockEmail" => @block_email,
    "from" => @from,
    "mfaEmail" => @mfa_email,
    "noActionEmail" => @no_action_email,
    "replyTo" => @reply_to,
  })
  result.compact
end