Class: AWSCDK::Pinpoint::CfnCampaign::MessageConfigurationProperty

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

Overview

Specifies the message configuration settings for a campaign.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(adm_message: nil, apns_message: nil, baidu_message: nil, custom_message: nil, default_message: nil, email_message: nil, gcm_message: nil, in_app_message: nil, sms_message: nil) ⇒ MessageConfigurationProperty

Returns a new instance of MessageConfigurationProperty.

Parameters:



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'pinpoint/cfn_campaign.rb', line 1685

def initialize(adm_message: nil, apns_message: nil, baidu_message: nil, custom_message: nil, default_message: nil, email_message: nil, gcm_message: nil, in_app_message: nil, sms_message: nil)
  @adm_message = adm_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageProperty.new(**adm_message.transform_keys(&:to_sym)) : adm_message
  Jsii::Type.check_type(@adm_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlUHJvcGVydHkifV19fQ==")), "admMessage") unless @adm_message.nil?
  @apns_message = apns_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageProperty.new(**apns_message.transform_keys(&:to_sym)) : apns_message
  Jsii::Type.check_type(@apns_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlUHJvcGVydHkifV19fQ==")), "apnsMessage") unless @apns_message.nil?
  @baidu_message = baidu_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageProperty.new(**baidu_message.transform_keys(&:to_sym)) : baidu_message
  Jsii::Type.check_type(@baidu_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlUHJvcGVydHkifV19fQ==")), "baiduMessage") unless @baidu_message.nil?
  @custom_message = custom_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignCustomMessageProperty.new(**custom_message.transform_keys(&:to_sym)) : custom_message
  Jsii::Type.check_type(@custom_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnbkN1c3RvbU1lc3NhZ2VQcm9wZXJ0eSJ9XX19")), "customMessage") unless @custom_message.nil?
  @default_message = default_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageProperty.new(**default_message.transform_keys(&:to_sym)) : default_message
  Jsii::Type.check_type(@default_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlUHJvcGVydHkifV19fQ==")), "defaultMessage") unless @default_message.nil?
  @email_message = email_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignEmailMessageProperty.new(**email_message.transform_keys(&:to_sym)) : email_message
  Jsii::Type.check_type(@email_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnbkVtYWlsTWVzc2FnZVByb3BlcnR5In1dfX0=")), "emailMessage") unless @email_message.nil?
  @gcm_message = gcm_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::MessageProperty.new(**gcm_message.transform_keys(&:to_sym)) : gcm_message
  Jsii::Type.check_type(@gcm_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5NZXNzYWdlUHJvcGVydHkifV19fQ==")), "gcmMessage") unless @gcm_message.nil?
  @in_app_message = in_app_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignInAppMessageProperty.new(**in_app_message.transform_keys(&:to_sym)) : in_app_message
  Jsii::Type.check_type(@in_app_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnbkluQXBwTWVzc2FnZVByb3BlcnR5In1dfX0=")), "inAppMessage") unless @in_app_message.nil?
  @sms_message = sms_message.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignSmsMessageProperty.new(**sms_message.transform_keys(&:to_sym)) : sms_message
  Jsii::Type.check_type(@sms_message, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnblNtc01lc3NhZ2VQcm9wZXJ0eSJ9XX19")), "smsMessage") unless @sms_message.nil?
end

Instance Attribute Details

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

The message that the campaign sends through the ADM (Amazon Device Messaging) channel.

If specified, this message overrides the default message.

Returns:

See Also:



1712
1713
1714
 
# File 'pinpoint/cfn_campaign.rb', line 1712

def adm_message
  @adm_message
end

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

The message that the campaign sends through the APNs (Apple Push Notification service) channel.

If specified, this message overrides the default message.

Returns:

See Also:



1719
1720
1721
 
# File 'pinpoint/cfn_campaign.rb', line 1719

def apns_message
  @apns_message
end

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

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.

If specified, this message overrides the default message.

Returns:

See Also:



1726
1727
1728
 
# File 'pinpoint/cfn_campaign.rb', line 1726

def baidu_message
  @baidu_message
end

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

The message that the campaign sends through a custom channel, as specified by the delivery configuration ( CustomDeliveryConfiguration ) settings for the campaign.

If specified, this message overrides the default message.

Returns:

See Also:



1733
1734
1735
 
# File 'pinpoint/cfn_campaign.rb', line 1733

def custom_message
  @custom_message
end

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

The default message that the campaign sends through all the channels that are configured for the campaign.

Returns:

See Also:



1738
1739
1740
 
# File 'pinpoint/cfn_campaign.rb', line 1738

def default_message
  @default_message
end

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

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

The maximum email message size is 200 KB. You can use email templates to send larger email messages.

Returns:

See Also:



1745
1746
1747
 
# File 'pinpoint/cfn_campaign.rb', line 1745

def email_message
  @email_message
end

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

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

If specified, this message overrides the default message.

Returns:

See Also:



1752
1753
1754
 
# File 'pinpoint/cfn_campaign.rb', line 1752

def gcm_message
  @gcm_message
end

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

The default message for the in-app messaging channel.

This message overrides the default message ( DefaultMessage ).

Returns:

See Also:



1759
1760
1761
 
# File 'pinpoint/cfn_campaign.rb', line 1759

def in_app_message
  @in_app_message
end

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

The message that the campaign sends through the SMS channel.

If specified, this message overrides the default message.

Returns:

See Also:



1766
1767
1768
 
# File 'pinpoint/cfn_campaign.rb', line 1766

def sms_message
  @sms_message
end

Class Method Details

.jsii_properties ⇒ Object 



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'pinpoint/cfn_campaign.rb', line 1768

def self.jsii_properties
  {
    :adm_message => "admMessage",
    :apns_message => "apnsMessage",
    :baidu_message => "baiduMessage",
    :custom_message => "customMessage",
    :default_message => "defaultMessage",
    :email_message => "emailMessage",
    :gcm_message => "gcmMessage",
    :in_app_message => "inAppMessage",
    :sms_message => "smsMessage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'pinpoint/cfn_campaign.rb', line 1782

def to_jsii
  result = {}
  result.merge!({
    "admMessage" => @adm_message,
    "apnsMessage" => @apns_message,
    "baiduMessage" => @baidu_message,
    "customMessage" => @custom_message,
    "defaultMessage" => @default_message,
    "emailMessage" => @email_message,
    "gcmMessage" => @gcm_message,
    "inAppMessage" => @in_app_message,
    "smsMessage" => @sms_message,
  })
  result.compact
end