Class CfnCampaign.MessageConfigurationProperty

Specifies the message configuration settings for a campaign.

Inheritance

object

CfnCampaign.MessageConfigurationProperty

Implements

CfnCampaign.IMessageConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCampaign.MessageConfigurationProperty : CfnCampaign.IMessageConfigurationProperty

Syntax (vb)

Public Class CfnCampaign.MessageConfigurationProperty Implements CfnCampaign.IMessageConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pinpoint;

             var customConfig;

             var messageConfigurationProperty = new MessageConfigurationProperty {
                 AdmMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 ApnsMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 BaiduMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 CustomMessage = new CampaignCustomMessageProperty {
                     Data = "data"
                 },
                 DefaultMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 EmailMessage = new CampaignEmailMessageProperty {
                     Body = "body",
                     FromAddress = "fromAddress",
                     HtmlBody = "htmlBody",
                     Title = "title"
                 },
                 GcmMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 InAppMessage = new CampaignInAppMessageProperty {
                     Content = new [] { new InAppMessageContentProperty {
                         BackgroundColor = "backgroundColor",
                         BodyConfig = new InAppMessageBodyConfigProperty {
                             Alignment = "alignment",
                             Body = "body",
                             TextColor = "textColor"
                         },
                         HeaderConfig = new InAppMessageHeaderConfigProperty {
                             Alignment = "alignment",
                             Header = "header",
                             TextColor = "textColor"
                         },
                         ImageUrl = "imageUrl",
                         PrimaryBtn = new InAppMessageButtonProperty {
                             Android = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             DefaultConfig = new DefaultButtonConfigurationProperty {
                                 BackgroundColor = "backgroundColor",
                                 BorderRadius = 123,
                                 ButtonAction = "buttonAction",
                                 Link = "link",
                                 Text = "text",
                                 TextColor = "textColor"
                             },
                             Ios = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             Web = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             }
                         },
                         SecondaryBtn = new InAppMessageButtonProperty {
                             Android = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             DefaultConfig = new DefaultButtonConfigurationProperty {
                                 BackgroundColor = "backgroundColor",
                                 BorderRadius = 123,
                                 ButtonAction = "buttonAction",
                                 Link = "link",
                                 Text = "text",
                                 TextColor = "textColor"
                             },
                             Ios = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             Web = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             }
                         }
                     } },
                     CustomConfig = customConfig,
                     Layout = "layout"
                 },
                 SmsMessage = new CampaignSmsMessageProperty {
                     Body = "body",
                     EntityId = "entityId",
                     MessageType = "messageType",
                     OriginationNumber = "originationNumber",
                     SenderId = "senderId",
                     TemplateId = "templateId"
                 }
             };

Synopsis

Constructors

MessageConfigurationProperty()

Specifies the message configuration settings for a campaign.

Properties

AdmMessage	The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
ApnsMessage	The message that the campaign sends through the APNs (Apple Push Notification service) channel.
BaiduMessage	The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
CustomMessage	The message that the campaign sends through a custom channel, as specified by the delivery configuration ( CustomDeliveryConfiguration ) settings for the campaign.
DefaultMessage	The default message that the campaign sends through all the channels that are configured for the campaign.
EmailMessage	The message that the campaign sends through the email channel. If specified, this message overrides the default message.
GcmMessage	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.
InAppMessage	The default message for the in-app messaging channel.
SmsMessage	The message that the campaign sends through the SMS channel.

Constructors

MessageConfigurationProperty()

Specifies the message configuration settings for a campaign.

public MessageConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pinpoint;

             var customConfig;

             var messageConfigurationProperty = new MessageConfigurationProperty {
                 AdmMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 ApnsMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 BaiduMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 CustomMessage = new CampaignCustomMessageProperty {
                     Data = "data"
                 },
                 DefaultMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 EmailMessage = new CampaignEmailMessageProperty {
                     Body = "body",
                     FromAddress = "fromAddress",
                     HtmlBody = "htmlBody",
                     Title = "title"
                 },
                 GcmMessage = new MessageProperty {
                     Action = "action",
                     Body = "body",
                     ImageIconUrl = "imageIconUrl",
                     ImageSmallIconUrl = "imageSmallIconUrl",
                     ImageUrl = "imageUrl",
                     JsonBody = "jsonBody",
                     MediaUrl = "mediaUrl",
                     RawContent = "rawContent",
                     SilentPush = false,
                     TimeToLive = 123,
                     Title = "title",
                     Url = "url"
                 },
                 InAppMessage = new CampaignInAppMessageProperty {
                     Content = new [] { new InAppMessageContentProperty {
                         BackgroundColor = "backgroundColor",
                         BodyConfig = new InAppMessageBodyConfigProperty {
                             Alignment = "alignment",
                             Body = "body",
                             TextColor = "textColor"
                         },
                         HeaderConfig = new InAppMessageHeaderConfigProperty {
                             Alignment = "alignment",
                             Header = "header",
                             TextColor = "textColor"
                         },
                         ImageUrl = "imageUrl",
                         PrimaryBtn = new InAppMessageButtonProperty {
                             Android = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             DefaultConfig = new DefaultButtonConfigurationProperty {
                                 BackgroundColor = "backgroundColor",
                                 BorderRadius = 123,
                                 ButtonAction = "buttonAction",
                                 Link = "link",
                                 Text = "text",
                                 TextColor = "textColor"
                             },
                             Ios = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             Web = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             }
                         },
                         SecondaryBtn = new InAppMessageButtonProperty {
                             Android = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             DefaultConfig = new DefaultButtonConfigurationProperty {
                                 BackgroundColor = "backgroundColor",
                                 BorderRadius = 123,
                                 ButtonAction = "buttonAction",
                                 Link = "link",
                                 Text = "text",
                                 TextColor = "textColor"
                             },
                             Ios = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             },
                             Web = new OverrideButtonConfigurationProperty {
                                 ButtonAction = "buttonAction",
                                 Link = "link"
                             }
                         }
                     } },
                     CustomConfig = customConfig,
                     Layout = "layout"
                 },
                 SmsMessage = new CampaignSmsMessageProperty {
                     Body = "body",
                     EntityId = "entityId",
                     MessageType = "messageType",
                     OriginationNumber = "originationNumber",
                     SenderId = "senderId",
                     TemplateId = "templateId"
                 }
             };

Properties

AdmMessage

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

public object? AdmMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-admmessage

ApnsMessage

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

public object? ApnsMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage

BaiduMessage

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

public object? BaiduMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-baidumessage

CustomMessage

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

public object? CustomMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage

DefaultMessage

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

public object? DefaultMessage { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-defaultmessage

EmailMessage

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

public object? EmailMessage { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-emailmessage

GcmMessage

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.

public object? GcmMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-gcmmessage

InAppMessage

The default message for the in-app messaging channel.

public object? InAppMessage { get; set; }

Property Value

object

Remarks

This message overrides the default message ( DefaultMessage ).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-inappmessage

SmsMessage

The message that the campaign sends through the SMS channel.

public object? SmsMessage { get; set; }

Property Value

object

Remarks

If specified, this message overrides the default message.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-smsmessage

Implements

CfnCampaign.IMessageConfigurationProperty