aws-cdk-lib.aws_pinpoint.CfnCampaign.MessageConfigurationProperty

interface MessageConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnCampaign.MessageConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaign_MessageConfigurationProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnCampaign.MessageConfigurationProperty
Pythonaws_cdk.aws_pinpoint.CfnCampaign.MessageConfigurationProperty
TypeScript aws-cdk-lib » aws_pinpoint » CfnCampaign » MessageConfigurationProperty

Specifies the message configuration settings for a campaign.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';

declare const customConfig: any;
const messageConfigurationProperty: pinpoint.CfnCampaign.MessageConfigurationProperty = {
  admMessage: {
    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: {
    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: {
    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: {
    data: 'data',
  },
  defaultMessage: {
    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: {
    body: 'body',
    fromAddress: 'fromAddress',
    htmlBody: 'htmlBody',
    title: 'title',
  },
  gcmMessage: {
    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: {
    content: [{
      backgroundColor: 'backgroundColor',
      bodyConfig: {
        alignment: 'alignment',
        body: 'body',
        textColor: 'textColor',
      },
      headerConfig: {
        alignment: 'alignment',
        header: 'header',
        textColor: 'textColor',
      },
      imageUrl: 'imageUrl',
      primaryBtn: {
        android: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
        defaultConfig: {
          backgroundColor: 'backgroundColor',
          borderRadius: 123,
          buttonAction: 'buttonAction',
          link: 'link',
          text: 'text',
          textColor: 'textColor',
        },
        ios: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
        web: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
      },
      secondaryBtn: {
        android: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
        defaultConfig: {
          backgroundColor: 'backgroundColor',
          borderRadius: 123,
          buttonAction: 'buttonAction',
          link: 'link',
          text: 'text',
          textColor: 'textColor',
        },
        ios: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
        web: {
          buttonAction: 'buttonAction',
          link: 'link',
        },
      },
    }],
    customConfig: customConfig,
    layout: 'layout',
  },
  smsMessage: {
    body: 'body',
    entityId: 'entityId',
    messageType: 'messageType',
    originationNumber: 'originationNumber',
    senderId: 'senderId',
    templateId: 'templateId',
  },
};

Properties

NameTypeDescription
admMessage?IResolvable | MessagePropertyThe message that the campaign sends through the ADM (Amazon Device Messaging) channel.
apnsMessage?IResolvable | MessagePropertyThe message that the campaign sends through the APNs (Apple Push Notification service) channel.
baiduMessage?IResolvable | MessagePropertyThe message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
customMessage?IResolvable | CampaignCustomMessagePropertyThe message that the campaign sends through a custom channel, as specified by the delivery configuration ( CustomDeliveryConfiguration ) settings for the campaign.
defaultMessage?IResolvable | MessagePropertyThe default message that the campaign sends through all the channels that are configured for the campaign.
emailMessage?IResolvable | CampaignEmailMessagePropertyThe message that the campaign sends through the email channel.
gcmMessage?IResolvable | MessagePropertyThe 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?IResolvable | CampaignInAppMessagePropertyThe default message for the in-app messaging channel.
smsMessage?IResolvable | CampaignSmsMessagePropertyThe message that the campaign sends through the SMS channel.

admMessage?

Type: IResolvable | MessageProperty (optional)

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

If specified, this message overrides the default message.


apnsMessage?

Type: IResolvable | MessageProperty (optional)

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

If specified, this message overrides the default message.


baiduMessage?

Type: IResolvable | MessageProperty (optional)

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

If specified, this message overrides the default message.


customMessage?

Type: IResolvable | CampaignCustomMessageProperty (optional)

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.


defaultMessage?

Type: IResolvable | MessageProperty (optional)

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


emailMessage?

Type: IResolvable | CampaignEmailMessageProperty (optional)

The message that the campaign sends through the email channel.

If specified, this message overrides the default message.


gcmMessage?

Type: IResolvable | MessageProperty (optional)

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.


inAppMessage?

Type: IResolvable | CampaignInAppMessageProperty (optional)

The default message for the in-app messaging channel.

This message overrides the default message ( DefaultMessage ).


smsMessage?

Type: IResolvable | CampaignSmsMessageProperty (optional)

The message that the campaign sends through the SMS channel.

If specified, this message overrides the default message.