Class: AWSCDK::Cognito::CfnUserPool::InviteMessageTemplateProperty

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

Overview

The template for the welcome message to new users.

This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_message: nil, email_subject: nil, sms_message: nil) ⇒ InviteMessageTemplateProperty

Returns a new instance of InviteMessageTemplateProperty.

Parameters:

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

    The message template for email messages.

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

    The subject line for email messages.

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

    The message template for SMS messages.



1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'cognito/cfn_user_pool.rb', line 1380

def initialize(email_message: nil, email_subject: nil, sms_message: nil)
  @email_message = email_message
  Jsii::Type.check_type(@email_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailMessage") unless @email_message.nil?
  @email_subject = email_subject
  Jsii::Type.check_type(@email_subject, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailSubject") unless @email_subject.nil?
  @sms_message = sms_message
  Jsii::Type.check_type(@sms_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "smsMessage") unless @sms_message.nil?
end

Instance Attribute Details

#email_message ⇒ String? (readonly)

The message template for email messages.

EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

Returns:

  • (String, nil)

See Also:



1395
1396
1397
 
# File 'cognito/cfn_user_pool.rb', line 1395

def email_message
  @email_message
end

#email_subject ⇒ String? (readonly)

The subject line for email messages.

EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

Returns:

  • (String, nil)

See Also:



1402
1403
1404
 
# File 'cognito/cfn_user_pool.rb', line 1402

def email_subject
  @email_subject
end

#sms_message ⇒ String? (readonly)

The message template for SMS messages.

Returns:

  • (String, nil)

See Also:



1407
1408
1409
 
# File 'cognito/cfn_user_pool.rb', line 1407

def sms_message
  @sms_message
end

Class Method Details

.jsii_properties ⇒ Object 



1409
1410
1411
1412
1413
1414
1415
 
# File 'cognito/cfn_user_pool.rb', line 1409

def self.jsii_properties
  {
    :email_message => "emailMessage",
    :email_subject => "emailSubject",
    :sms_message => "smsMessage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'cognito/cfn_user_pool.rb', line 1417

def to_jsii
  result = {}
  result.merge!({
    "emailMessage" => @email_message,
    "emailSubject" => @email_subject,
    "smsMessage" => @sms_message,
  })
  result.compact
end