Class: AWSCDK::Cognito::EmailSettings

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/email_settings.rb

Overview

Email settings for the user pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(from: nil, reply_to: nil) ⇒ EmailSettings

Returns a new instance of EmailSettings.

Parameters:

  • from (String, nil) (defaults to: nil) —

    The 'from' address on the emails received by the user.

  • reply_to (String, nil) (defaults to: nil) —

    The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.



9
10
11
12
13
14
 
# File 'cognito/email_settings.rb', line 9

def initialize(from: nil, reply_to: nil)
  @from = from
  Jsii::Type.check_type(@from, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "from") unless @from.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

#from ⇒ String? (readonly)

Note:

Default: noreply@verificationemail.com

The 'from' address on the emails received by the user.

Returns:

  • (String, nil) 


20
21
22
 
# File 'cognito/email_settings.rb', line 20

def from
  @from
end

#reply_to ⇒ String? (readonly)

Note:

Default: - Not set.

The 'replyTo' address on the emails received by the user as defined by IETF RFC-5322.

When set, most email clients recognize to change 'to' line to this address when a reply is drafted.

Returns:

  • (String, nil) 


27
28
29
 
# File 'cognito/email_settings.rb', line 27

def reply_to
  @reply_to
end

Class Method Details

.jsii_properties ⇒ Object 



29
30
31
32
33
34
 
# File 'cognito/email_settings.rb', line 29

def self.jsii_properties
  {
    :from => "from",
    :reply_to => "replyTo",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'cognito/email_settings.rb', line 36

def to_jsii
  result = {}
  result.merge!({
    "from" => @from,
    "replyTo" => @reply_to,
  })
  result.compact
end