@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/out/exports/resources.generated/aws-pinpoint-campaign.d.ts

@@ -0,0 +1,785 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html}
+ */
+export type PinpointCampaign = ResourceDefinitionWithAttributes<"AWS::Pinpoint::Campaign", PinpointCampaignProps, PinpointCampaignAttribs>;
+/**
+ * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html}
+ */
+export type PinpointCampaignProps = {
+    /**
+     * An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments}
+     */
+    AdditionalTreatments?: WriteTreatmentResource[] | undefined;
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid}
+     */
+    ApplicationId: string;
+    /**
+     * Specifies the Lambda function to use as a code hook for a campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook}
+     */
+    CampaignHook?: CampaignHook | undefined;
+    /**
+     * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration}
+     */
+    CustomDeliveryConfiguration?: CustomDeliveryConfiguration | undefined;
+    /**
+     * A custom description of the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description}
+     */
+    Description?: string | undefined;
+    /**
+     * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent}
+     */
+    HoldoutPercent?: number | undefined;
+    /**
+     * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused}
+     */
+    IsPaused?: boolean | undefined;
+    /**
+     * The messaging limits for the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits}
+     */
+    Limits?: Limits | undefined;
+    /**
+     * The message configuration settings for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration}
+     */
+    MessageConfiguration?: MessageConfiguration | undefined;
+    /**
+     * The name of the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name}
+     */
+    Name: string;
+    /**
+     * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-priority}
+     */
+    Priority?: number | undefined;
+    /**
+     * The schedule settings for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule}
+     */
+    Schedule: Schedule;
+    /**
+     * The unique identifier for the segment to associate with the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid}
+     */
+    SegmentId: string;
+    /**
+     * The version of the segment to associate with the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion}
+     */
+    SegmentVersion?: number | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags}
+     */
+    Tags?: Record<string, unknown> | undefined;
+    /**
+     * The message template to use for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration}
+     */
+    TemplateConfiguration?: TemplateConfiguration | undefined;
+    /**
+     * A custom description of the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription}
+     */
+    TreatmentDescription?: string | undefined;
+    /**
+     * A custom name for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname}
+     */
+    TreatmentName?: string | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#aws-resource-pinpoint-campaign-return-values}
+ */
+export type PinpointCampaignAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-arn}
+     */
+    Arn: string;
+    /**
+     * The unique identifier for the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignid}
+     */
+    CampaignId: string;
+};
+/**
+ * Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html}
+ */
+export type CampaignCustomMessage = {
+    /**
+     * The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html#cfn-pinpoint-campaign-campaigncustommessage-data}
+     */
+    Data?: string | undefined;
+};
+/**
+ * Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html}
+ */
+export type CampaignEmailMessage = {
+    /**
+     * The body of the email for recipients whose email clients don't render HTML content.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-body}
+     */
+    Body?: string | undefined;
+    /**
+     * The verified email address to send the email from. The default address is the `FromAddress` specified for the email channel for the application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-fromaddress}
+     */
+    FromAddress?: string | undefined;
+    /**
+     * The body of the email, in HTML format, for recipients whose email clients render HTML content.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-htmlbody}
+     */
+    HtmlBody?: string | undefined;
+    /**
+     * The subject line, or title, of the email.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-title}
+     */
+    Title?: string | undefined;
+};
+/**
+ * Specifies the settings for events that cause a campaign to be sent.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html}
+ */
+export type CampaignEventFilter = {
+    /**
+     * The dimension settings of the event filter for the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-dimensions}
+     */
+    Dimensions?: EventDimensions | undefined;
+    /**
+     * The type of event that causes the campaign to be sent. Valid values are: `SYSTEM` , sends the campaign when a system event occurs; and, `ENDPOINT` , sends the campaign when an endpoint event (Events resource) occurs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-filtertype}
+     */
+    FilterType?: string | undefined;
+};
+/**
+ * Specifies settings for invoking an Lambda function that customizes a segment for a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html}
+ */
+export type CampaignHook = {
+    /**
+     * The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-lambdafunctionname}
+     */
+    LambdaFunctionName?: string | undefined;
+    /**
+     * The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:
+     *
+     * - `FILTER` - Invoke the function to customize the segment that's used by a campaign.
+     * - `DELIVERY` - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the `CustomDeliveryConfiguration` and `CampaignCustomMessage` objects of the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-mode}
+     */
+    Mode?: string | undefined;
+    /**
+     * The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-weburl}
+     */
+    WebUrl?: string | undefined;
+};
+/**
+ * Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html}
+ */
+export type CampaignInAppMessage = {
+    /**
+     * An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-content}
+     */
+    Content?: InAppMessageContent[] | undefined;
+    /**
+     * Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-customconfig}
+     */
+    CustomConfig?: Record<string, unknown> | undefined;
+    /**
+     * A string that describes how the in-app message will appear. You can specify one of the following:
+     *
+     * - `BOTTOM_BANNER` – a message that appears as a banner at the bottom of the page.
+     * - `TOP_BANNER` – a message that appears as a banner at the top of the page.
+     * - `OVERLAYS` – a message that covers entire screen.
+     * - `MOBILE_FEED` – a message that appears in a window in front of the page.
+     * - `MIDDLE_BANNER` – a message that appears as a banner in the middle of the page.
+     * - `CAROUSEL` – a scrollable layout of up to five unique messages.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-layout}
+     */
+    Layout?: string | undefined;
+};
+/**
+ * Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html}
+ */
+export type CampaignSmsMessage = {
+    /**
+     * The body of the SMS message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-body}
+     */
+    Body?: string | undefined;
+    /**
+     * The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-entityid}
+     */
+    EntityId?: string | undefined;
+    /**
+     * The SMS message type. Valid values are `TRANSACTIONAL` (for messages that are critical or time-sensitive, such as a one-time passwords) and `PROMOTIONAL` (for messsages that aren't critical or time-sensitive, such as marketing messages).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-messagetype}
+     */
+    MessageType?: string | undefined;
+    /**
+     * The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-originationnumber}
+     */
+    OriginationNumber?: string | undefined;
+    /**
+     * The alphabetic Sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use `OriginationNumber` instead. For more information about support for Sender ID by country, see the [Amazon Pinpoint User Guide](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-senderid}
+     */
+    SenderId?: string | undefined;
+    /**
+     * The template ID received from the regulatory body for sending SMS in your country.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-templateid}
+     */
+    TemplateId?: string | undefined;
+};
+/**
+ * Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the `CampaignCustomMessage` object to define the message to send for the campaign or campaign treatment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html}
+ */
+export type CustomDeliveryConfiguration = {
+    /**
+     * The destination to send the campaign or treatment to. This value can be one of the following:
+     *
+     * - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
+     * - The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-deliveryuri}
+     */
+    DeliveryUri?: string | undefined;
+    /**
+     * The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the `ChannelType` property of an endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-endpointtypes}
+     */
+    EndpointTypes?: string[] | undefined;
+};
+/**
+ * Specifies the default behavior for a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html}
+ */
+export type DefaultButtonConfiguration = {
+    /**
+     * The background color of a button, expressed as a hex color code (such as #000000 for black).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-backgroundcolor}
+     */
+    BackgroundColor?: string | undefined;
+    /**
+     * The border radius of a button.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-borderradius}
+     */
+    BorderRadius?: number | undefined;
+    /**
+     * The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:
+     *
+     * - `LINK` – A link to a web destination.
+     * - `DEEP_LINK` – A link to a specific page in an application.
+     * - `CLOSE` – Dismisses the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-buttonaction}
+     */
+    ButtonAction?: string | undefined;
+    /**
+     * The destination (such as a URL) for a button.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-link}
+     */
+    Link?: string | undefined;
+    /**
+     * The text that appears on a button in an in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-text}
+     */
+    Text?: string | undefined;
+    /**
+     * The color of the body text in a button, expressed as a hex color code (such as #000000 for black).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-textcolor}
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html}
+ */
+export type EventDimensions = {
+    /**
+     * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-attributes}
+     */
+    Attributes?: Record<string, unknown> | undefined;
+    /**
+     * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered` or `_custom.delivered` . For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the *Amazon Pinpoint Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-eventtype}
+     */
+    EventType?: SetDimension | undefined;
+    /**
+     * One or more custom metrics that your application reports to Amazon Pinpoint . You can use these metrics as selection criteria when you create an event filter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-metrics}
+     */
+    Metrics?: Record<string, unknown> | undefined;
+};
+/**
+ * Specifies the configuration of main body text of the in-app message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html}
+ */
+export type InAppMessageBodyConfig = {
+    /**
+     * The text alignment of the main body text of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-alignment}
+     */
+    Alignment?: string | undefined;
+    /**
+     * The main body text of the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-body}
+     */
+    Body?: string | undefined;
+    /**
+     * The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-textcolor}
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the configuration of a button that appears in an in-app message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html}
+ */
+export type InAppMessageButton = {
+    /**
+     * An object that defines the default behavior for a button in in-app messages sent to Android.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-android}
+     */
+    Android?: OverrideButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in an in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-defaultconfig}
+     */
+    DefaultConfig?: DefaultButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in in-app messages sent to iOS devices.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-ios}
+     */
+    IOS?: OverrideButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in in-app messages for web applications.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-web}
+     */
+    Web?: OverrideButtonConfiguration | undefined;
+};
+/**
+ * Specifies the configuration and contents of an in-app message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html}
+ */
+export type InAppMessageContent = {
+    /**
+     * The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-backgroundcolor}
+     */
+    BackgroundColor?: string | undefined;
+    /**
+     * Specifies the configuration of main body text in an in-app message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-bodyconfig}
+     */
+    BodyConfig?: InAppMessageBodyConfig | undefined;
+    /**
+     * Specifies the configuration and content of the header or title text of the in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-headerconfig}
+     */
+    HeaderConfig?: InAppMessageHeaderConfig | undefined;
+    /**
+     * The URL of the image that appears on an in-app message banner.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-imageurl}
+     */
+    ImageUrl?: string | undefined;
+    /**
+     * An object that contains configuration information about the primary button in an in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-primarybtn}
+     */
+    PrimaryBtn?: InAppMessageButton | undefined;
+    /**
+     * An object that contains configuration information about the secondary button in an in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-secondarybtn}
+     */
+    SecondaryBtn?: InAppMessageButton | undefined;
+};
+/**
+ * Specifies the configuration and content of the header or title text of the in-app message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html}
+ */
+export type InAppMessageHeaderConfig = {
+    /**
+     * The text alignment of the title of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-alignment}
+     */
+    Alignment?: string | undefined;
+    /**
+     * The header or title text of the in-app message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-header}
+     */
+    Header?: string | undefined;
+    /**
+     * The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-textcolor}
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the limits on the messages that a campaign can send.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html}
+ */
+export type Limits = {
+    /**
+     * The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-daily}
+     */
+    Daily?: number | undefined;
+    /**
+     * The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-maximumduration}
+     */
+    MaximumDuration?: number | undefined;
+    /**
+     * The maximum number of messages that a campaign can send each second. The minimum value is 1. The maximum value is 20,000.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-messagespersecond}
+     */
+    MessagesPerSecond?: number | undefined;
+    /**
+     * The maximum number of messages that the campaign can send per user session.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-session}
+     */
+    Session?: number | undefined;
+    /**
+     * The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-total}
+     */
+    Total?: number | undefined;
+};
+/**
+ * Specifies the content and settings for a push notification that's sent to recipients of a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html}
+ */
+export type Message = {
+    /**
+     * The action to occur if a recipient taps the push notification. Valid values are:
+     *
+     * - `OPEN_APP` – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
+     * - `DEEP_LINK` – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
+     * - `URL` – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-action}
+     */
+    Action?: string | undefined;
+    /**
+     * The body of the notification message. The maximum number of characters is 200.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-body}
+     */
+    Body?: string | undefined;
+    /**
+     * The URL of the image to display as the push notification icon, such as the icon for the app.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageiconurl}
+     */
+    ImageIconUrl?: string | undefined;
+    /**
+     * The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imagesmalliconurl}
+     */
+    ImageSmallIconUrl?: string | undefined;
+    /**
+     * The URL of an image to display in the push notification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageurl}
+     */
+    ImageUrl?: string | undefined;
+    /**
+     * The JSON payload to use for a silent push notification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-jsonbody}
+     */
+    JsonBody?: string | undefined;
+    /**
+     * The URL of the image or video to display in the push notification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-mediaurl}
+     */
+    MediaUrl?: string | undefined;
+    /**
+     * The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-rawcontent}
+     */
+    RawContent?: string | undefined;
+    /**
+     * Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-silentpush}
+     */
+    SilentPush?: boolean | undefined;
+    /**
+     * The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push notification service. If this value is `0` , the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
+     *
+     * This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-timetolive}
+     */
+    TimeToLive?: number | undefined;
+    /**
+     * The title to display above the notification message on a recipient's device.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-title}
+     */
+    Title?: string | undefined;
+    /**
+     * The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the `Action` property is `URL` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-url}
+     */
+    Url?: string | undefined;
+};
+/**
+ * Specifies the message configuration settings for a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html}
+ */
+export type MessageConfiguration = {
+    /**
+     * The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-admmessage}
+     */
+    ADMMessage?: Message | undefined;
+    /**
+     * The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage}
+     */
+    APNSMessage?: Message | undefined;
+    /**
+     * The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-baidumessage}
+     */
+    BaiduMessage?: Message | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage}
+     */
+    CustomMessage?: CampaignCustomMessage | undefined;
+    /**
+     * The default message that the campaign sends through all the channels that are configured for the campaign.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-defaultmessage}
+     */
+    DefaultMessage?: Message | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-emailmessage}
+     */
+    EmailMessage?: CampaignEmailMessage | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-gcmmessage}
+     */
+    GCMMessage?: Message | undefined;
+    /**
+     * The default message for the in-app messaging channel. This message overrides the default message ( `DefaultMessage` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-inappmessage}
+     */
+    InAppMessage?: CampaignInAppMessage | undefined;
+    /**
+     * The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-smsmessage}
+     */
+    SMSMessage?: CampaignSmsMessage | undefined;
+};
+/**
+ * Specifies the configuration of a button with settings that are specific to a certain device type.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-overridebuttonconfiguration.html}
+ */
+export type OverrideButtonConfiguration = {
+    /**
+     * The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:
+     *
+     * - `LINK` – A link to a web destination.
+     * - `DEEP_LINK` – A link to a specific page in an application.
+     * - `CLOSE` – Dismisses the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-overridebuttonconfiguration.html#cfn-pinpoint-campaign-overridebuttonconfiguration-buttonaction}
+     */
+    ButtonAction?: string | undefined;
+    /**
+     * The destination (such as a URL) for a button.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-overridebuttonconfiguration.html#cfn-pinpoint-campaign-overridebuttonconfiguration-link}
+     */
+    Link?: string | undefined;
+};
+/**
+ * Specifies the start and end times that define a time range when messages aren't sent to endpoints.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-quiettime.html}
+ */
+export type QuietTime = {
+    /**
+     * The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-quiettime.html#cfn-pinpoint-campaign-quiettime-end}
+     */
+    End: string;
+    /**
+     * The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-quiettime.html#cfn-pinpoint-campaign-quiettime-start}
+     */
+    Start: string;
+};
+/**
+ * Specifies the schedule settings for a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html}
+ */
+export type Schedule = {
+    /**
+     * The scheduled time, in ISO 8601 format, when the campaign ended or will end.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-endtime}
+     */
+    EndTime?: string | undefined;
+    /**
+     * The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-eventfilter}
+     */
+    EventFilter?: CampaignEventFilter | undefined;
+    /**
+     * Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-frequency}
+     */
+    Frequency?: string | undefined;
+    /**
+     * Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to `true` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-islocaltime}
+     */
+    IsLocalTime?: boolean | undefined;
+    /**
+     * The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
+     *
+     * - The `EndpointDemographic.Timezone` property of the endpoint is set to a valid value.
+     * - The current time in the endpoint's time zone is later than or equal to the time specified by the `QuietTime.Start` property for the campaign.
+     * - The current time in the endpoint's time zone is earlier than or equal to the time specified by the `QuietTime.End` property for the campaign.
+     *
+     * If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-quiettime}
+     */
+    QuietTime?: QuietTime | undefined;
+    /**
+     * The scheduled time when the campaign began or will begin. Valid values are: `IMMEDIATE` , to start the campaign immediately; or, a specific time in ISO 8601 format.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-starttime}
+     */
+    StartTime?: string | undefined;
+    /**
+     * The starting UTC offset for the campaign schedule, if the value of the `IsLocalTime` property is `true` . Valid values are: `UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10,` and `UTC-11` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-timezone}
+     */
+    TimeZone?: string | undefined;
+};
+/**
+ * Specifies the dimension type and values for a segment dimension.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html}
+ */
+export type SetDimension = {
+    /**
+     * The type of segment dimension to use. Valid values are: `INCLUSIVE` , endpoints that match the criteria are included in the segment; and, `EXCLUSIVE` , endpoints that match the criteria are excluded from the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-dimensiontype}
+     */
+    DimensionType?: string | undefined;
+    /**
+     * The criteria values to use for the segment dimension. Depending on the value of the `DimensionType` property, endpoints are included or excluded from the segment if their values match the criteria values.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-values}
+     */
+    Values?: string[] | undefined;
+};
+/**
+ * Specifies the name and version of the message template to use for the message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html}
+ */
+export type Template = {
+    /**
+     * The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-name}
+     */
+    Name?: string | undefined;
+    /**
+     * The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the [Template Versions](https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html) resource.
+     *
+     * If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-version}
+     */
+    Version?: string | undefined;
+};
+/**
+ * Specifies the message template to use for the message, for each type of channel.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html}
+ */
+export type TemplateConfiguration = {
+    /**
+     * The email template to use for the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-emailtemplate}
+     */
+    EmailTemplate?: Template | undefined;
+    /**
+     * The push notification template to use for the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-pushtemplate}
+     */
+    PushTemplate?: Template | undefined;
+    /**
+     * The SMS template to use for the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-smstemplate}
+     */
+    SMSTemplate?: Template | undefined;
+    /**
+     * The voice template to use for the message. This object isn't supported for campaigns.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-voicetemplate}
+     */
+    VoiceTemplate?: Template | undefined;
+};
+/**
+ * Specifies the settings for a campaign treatment. A *treatment* is a variation of a campaign that's used for A/B testing of a campaign.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html}
+ */
+export type WriteTreatmentResource = {
+    /**
+     * 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration}
+     */
+    CustomDeliveryConfiguration?: CustomDeliveryConfiguration | undefined;
+    /**
+     * The message configuration settings for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration}
+     */
+    MessageConfiguration?: MessageConfiguration | undefined;
+    /**
+     * The schedule settings for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-schedule}
+     */
+    Schedule?: Schedule | undefined;
+    /**
+     * The allocated percentage of users (segment members) to send the treatment to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-sizepercent}
+     */
+    SizePercent?: number | undefined;
+    /**
+     * The message template to use for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration}
+     */
+    TemplateConfiguration?: TemplateConfiguration | undefined;
+    /**
+     * A custom description of the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription}
+     */
+    TreatmentDescription?: string | undefined;
+    /**
+     * A custom name for the treatment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentname}
+     */
+    TreatmentName?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpoint-campaign.d.ts.map