Class: AWSCDK::Pinpoint::CfnCampaign::CampaignSmsMessageProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_campaign.rb

Overview

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body: nil, entity_id: nil, message_type: nil, origination_number: nil, sender_id: nil, template_id: nil) ⇒ CampaignSmsMessageProperty

Returns a new instance of CampaignSmsMessageProperty.

Parameters:

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

    The body of the SMS message.

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

    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

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

    The SMS message type.

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

    The long code to send the SMS message from.

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

    The alphabetic Sender ID to display as the sender of the message on a recipient's device.

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

    The template ID received from the regulatory body for sending SMS in your country.



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'pinpoint/cfn_campaign.rb', line 1056

def initialize(body: nil, entity_id: nil, message_type: nil, origination_number: nil, sender_id: nil, template_id: nil)
  @body = body
  Jsii::Type.check_type(@body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "body") unless @body.nil?
  @entity_id = entity_id
  Jsii::Type.check_type(@entity_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityId") unless @entity_id.nil?
  @message_type = message_type
  Jsii::Type.check_type(@message_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "messageType") unless @message_type.nil?
  @origination_number = origination_number
  Jsii::Type.check_type(@origination_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originationNumber") unless @origination_number.nil?
  @sender_id = sender_id
  Jsii::Type.check_type(@sender_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "senderId") unless @sender_id.nil?
  @template_id = template_id
  Jsii::Type.check_type(@template_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateId") unless @template_id.nil?
end

Instance Attribute Details

#body ⇒ String? (readonly)

The body of the SMS message.

Returns:

  • (String, nil)

See Also:



1075
1076
1077
 
# File 'pinpoint/cfn_campaign.rb', line 1075

def body
  @body
end

#entity_id ⇒ String? (readonly)

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Returns:

  • (String, nil)

See Also:



1080
1081
1082
 
# File 'pinpoint/cfn_campaign.rb', line 1080

def entity_id
  @entity_id
end

#message_type ⇒ String? (readonly)

The SMS message type.

Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

Returns:

  • (String, nil)

See Also:



1087
1088
1089
 
# File 'pinpoint/cfn_campaign.rb', line 1087

def message_type
  @message_type
end

#origination_number ⇒ String? (readonly)

The long code to send the SMS message from.

This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

Returns:

  • (String, nil)

See Also:



1094
1095
1096
 
# File 'pinpoint/cfn_campaign.rb', line 1094

def origination_number
  @origination_number
end

#sender_id ⇒ String? (readonly)

The alphabetic Sender ID to display as the sender of the message on a recipient's device.

Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use OriginationNumber instead. For more information about support for Sender ID by country, see the Amazon Pinpoint User Guide .

Returns:

  • (String, nil)

See Also:



1101
1102
1103
 
# File 'pinpoint/cfn_campaign.rb', line 1101

def sender_id
  @sender_id
end

#template_id ⇒ String? (readonly)

The template ID received from the regulatory body for sending SMS in your country.

Returns:

  • (String, nil)

See Also:



1106
1107
1108
 
# File 'pinpoint/cfn_campaign.rb', line 1106

def template_id
  @template_id
end

Class Method Details

.jsii_properties ⇒ Object 



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'pinpoint/cfn_campaign.rb', line 1108

def self.jsii_properties
  {
    :body => "body",
    :entity_id => "entityId",
    :message_type => "messageType",
    :origination_number => "originationNumber",
    :sender_id => "senderId",
    :template_id => "templateId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'pinpoint/cfn_campaign.rb', line 1119

def to_jsii
  result = {}
  result.merge!({
    "body" => @body,
    "entityId" => @entity_id,
    "messageType" => @message_type,
    "originationNumber" => @origination_number,
    "senderId" => @sender_id,
    "templateId" => @template_id,
  })
  result.compact
end