Class: AWSCDK::Pinpoint::CfnSMSChannelProps

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

Overview

Properties for defining a CfnSMSChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, enabled: nil, sender_id: nil, short_code: nil) ⇒ CfnSMSChannelProps

Returns a new instance of CfnSMSChannelProps.

Parameters:

  • application_id (String) —

    The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

  • enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to enable the SMS channel for the application.

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

    The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

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

    The registered short code that you want to use when you send messages through the SMS channel.



13
14
15
16
17
18
19
20
21
22
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 13

def initialize(application_id:, enabled: nil, sender_id: nil, short_code: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @sender_id = sender_id
  Jsii::Type.check_type(@sender_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "senderId") unless @sender_id.nil?
  @short_code = short_code
  Jsii::Type.check_type(@short_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shortCode") unless @short_code.nil?
end

Instance Attribute Details

#application_id ⇒ String (readonly)

The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 28

def application_id
  @application_id
end

#enabled ⇒ Boolean, ... (readonly)

Specifies whether to enable the SMS channel for the application.

Returns:

See Also:



33
34
35
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 33

def enabled
  @enabled
end

#sender_id ⇒ String? (readonly)

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide .

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 40

def sender_id
  @sender_id
end

#short_code ⇒ String? (readonly)

The registered short code that you want to use when you send messages through the SMS channel.

For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide .

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 47

def short_code
  @short_code
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 49

def self.jsii_properties
  {
    :application_id => "applicationId",
    :enabled => "enabled",
    :sender_id => "senderId",
    :short_code => "shortCode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'pinpoint/cfn_sms_channel_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "enabled" => @enabled,
    "senderId" => @sender_id,
    "shortCode" => @short_code,
  })
  result.compact
end