class CfnCampaignPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Pinpoint.Mixins.CfnCampaignPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspinpoint/mixins#CfnCampaignPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.pinpoint.mixins.CfnCampaignPropsMixin
Python	aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnCampaignPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_pinpoint » mixins » CfnCampaignPropsMixin

Implements IMixin

Extends Mixin

Specifies the settings for a campaign.

A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

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 { mixins } from '@aws-cdk/mixins-preview';
import { mixins as pinpoint_mixins } from '@aws-cdk/mixins-preview/aws-pinpoint';

declare const attributes: any;
declare const customConfig: any;
declare const metrics: any;
declare const tags: any;
const cfnCampaignPropsMixin = new pinpoint_mixins.CfnCampaignPropsMixin({
  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',
  }],
  applicationId: 'applicationId',
  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',
    },
  },
  name: 'name',
  priority: 123,
  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',
  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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnCampaignPropsMixin(props: CfnCampaignMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCampaignMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Pinpoint::Campaign.

Properties

Name	Type	Description
props	CfnCampaignMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCampaignMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.