interface CfnCampaignProps

Language	Type name
.NET	Amazon.CDK.AWS.Pinpoint.CfnCampaignProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaignProps
Java	software.amazon.awscdk.services.pinpoint.CfnCampaignProps
Python	aws_cdk.aws_pinpoint.CfnCampaignProps
TypeScript	aws-cdk-lib » aws_pinpoint » CfnCampaignProps

Properties for defining a CfnCampaign.

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

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 attributes: any;
declare const customConfig: any;
declare const metrics: any;
declare const tags: any;
const cfnCampaignProps: pinpoint.CfnCampaignProps = {
  applicationId: 'applicationId',
  name: 'name',
  schedule: {
    endTime: 'endTime',
    eventFilter: {
      dimensions: {
        attributes: attributes,
        eventType: {
          dimensionType: 'dimensionType',
          values: ['values'],
        },
        metrics: metrics,
      },
      filterType: 'filterType',
    },
    frequency: 'frequency',
    isLocalTime: false,
    quietTime: {
      end: 'end',
      start: 'start',
    },
    startTime: 'startTime',
    timeZone: 'timeZone',
  },
  segmentId: 'segmentId',

  // the properties below are optional
  additionalTreatments: [{
    customDeliveryConfiguration: {
      deliveryUri: 'deliveryUri',
      endpointTypes: ['endpointTypes'],
    },
    messageConfiguration: {
      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',
      },
    },
    schedule: {
      endTime: 'endTime',
      eventFilter: {
        dimensions: {
          attributes: attributes,
          eventType: {
            dimensionType: 'dimensionType',
            values: ['values'],
          },
          metrics: metrics,
        },
        filterType: 'filterType',
      },
      frequency: 'frequency',
      isLocalTime: false,
      quietTime: {
        end: 'end',
        start: 'start',
      },
      startTime: 'startTime',
      timeZone: 'timeZone',
    },
    sizePercent: 123,
    templateConfiguration: {
      emailTemplate: {
        name: 'name',
        version: 'version',
      },
      pushTemplate: {
        name: 'name',
        version: 'version',
      },
      smsTemplate: {
        name: 'name',
        version: 'version',
      },
      voiceTemplate: {
        name: 'name',
        version: 'version',
      },
    },
    treatmentDescription: 'treatmentDescription',
    treatmentName: 'treatmentName',
  }],
  campaignHook: {
    lambdaFunctionName: 'lambdaFunctionName',
    mode: 'mode',
    webUrl: 'webUrl',
  },
  customDeliveryConfiguration: {
    deliveryUri: 'deliveryUri',
    endpointTypes: ['endpointTypes'],
  },
  description: 'description',
  holdoutPercent: 123,
  isPaused: false,
  limits: {
    daily: 123,
    maximumDuration: 123,
    messagesPerSecond: 123,
    session: 123,
    total: 123,
  },
  messageConfiguration: {
    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',
    },
  },
  priority: 123,
  segmentVersion: 123,
  tags: tags,
  templateConfiguration: {
    emailTemplate: {
      name: 'name',
      version: 'version',
    },
    pushTemplate: {
      name: 'name',
      version: 'version',
    },
    smsTemplate: {
      name: 'name',
      version: 'version',
    },
    voiceTemplate: {
      name: 'name',
      version: 'version',
    },
  },
  treatmentDescription: 'treatmentDescription',
  treatmentName: 'treatmentName',
};

Properties

Name	Type	Description
applicationId	string	The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
name	string	The name of the campaign.
schedule	IResolvable | ScheduleProperty	The schedule settings for the treatment.
segmentId	string	The unique identifier for the segment to associate with the campaign.
additionalTreatments?	IResolvable | IResolvable | WriteTreatmentResourceProperty[]	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
campaignHook?	IResolvable | CampaignHookProperty	Specifies the Lambda function to use as a code hook for a campaign.
customDeliveryConfiguration?	IResolvable | CustomDeliveryConfigurationProperty	The delivery configuration settings for sending the treatment through a custom channel.
description?	string	A custom description of the campaign.
holdoutPercent?	number	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
isPaused?	boolean | IResolvable	Specifies whether to pause the campaign.
limits?	IResolvable | LimitsProperty	The messaging limits for the campaign.
messageConfiguration?	IResolvable | MessageConfigurationProperty	The message configuration settings for the treatment.
priority?	number	An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.
segmentVersion?	number	The version of the segment to associate with the campaign.
tags?	any	An array of key-value pairs to apply to this resource.
templateConfiguration?	IResolvable | TemplateConfigurationProperty	The message template to use for the treatment.
treatmentDescription?	string	A custom description of the treatment.
treatmentName?	string	A custom name for the treatment.

---

applicationId

Type: string

The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid

---

name

Type: string

The name of the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name

---

schedule

Type: IResolvable | ScheduleProperty

The schedule settings for the treatment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule

---

segmentId

Type: string

The unique identifier for the segment to associate with the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid

---

additionalTreatments?

Type: IResolvable | IResolvable | WriteTreatmentResourceProperty[] (optional)

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments

---

campaignHook?

Type: IResolvable | CampaignHookProperty (optional)

Specifies the Lambda function to use as a code hook for a campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook

---

customDeliveryConfiguration?

Type: IResolvable | CustomDeliveryConfigurationProperty (optional)

The delivery configuration settings for sending the treatment through a custom channel.

This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration

---

description?

Type: string (optional)

A custom description of the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description

---

holdoutPercent?

Type: number (optional)

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent

---

isPaused?

Type: boolean | IResolvable (optional)

Specifies whether to pause the campaign.

A paused campaign doesn't run unless you resume it by changing this value to false . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused

---

limits?

Type: IResolvable | LimitsProperty (optional)

The messaging limits for the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits

---

messageConfiguration?

Type: IResolvable | MessageConfigurationProperty (optional)

The message configuration settings for the treatment.

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

---

priority?

Type: number (optional)

An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-priority

---

segmentVersion?

Type: number (optional)

The version of the segment to associate with the campaign.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion

---

tags?

Type: any (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags

---

templateConfiguration?

Type: IResolvable | TemplateConfigurationProperty (optional)

The message template to use for the treatment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration

---

treatmentDescription?

Type: string (optional)

A custom description of the treatment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription

---

treatmentName?

Type: string (optional)

A custom name for the treatment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname