@propulsionworks/cloudformation 0.0.1 → 0.1.0

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

@@ -0,0 +1,636 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+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.
+ */
+export type PinpointCampaignProps = {
+    /**
+     * An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
+     */
+    AdditionalTreatments?: WriteTreatmentResource[] | undefined;
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
+     */
+    ApplicationId: string;
+    /**
+     * Specifies the Lambda function to use as a code hook for a campaign.
+     */
+    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.
+     */
+    CustomDeliveryConfiguration?: CustomDeliveryConfiguration | undefined;
+    /**
+     * A custom description of the campaign.
+     */
+    Description?: string | undefined;
+    /**
+     * The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
+     */
+    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.
+     */
+    IsPaused?: boolean | undefined;
+    /**
+     * The messaging limits for the campaign.
+     */
+    Limits?: Limits | undefined;
+    /**
+     * The message configuration settings for the treatment.
+     */
+    MessageConfiguration?: MessageConfiguration | undefined;
+    /**
+     * The name of the campaign.
+     */
+    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.
+     */
+    Priority?: number | undefined;
+    /**
+     * The schedule settings for the treatment.
+     */
+    Schedule: Schedule;
+    /**
+     * The unique identifier for the segment to associate with the campaign.
+     */
+    SegmentId: string;
+    /**
+     * The version of the segment to associate with the campaign.
+     */
+    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) .
+     */
+    Tags?: Record<string, unknown> | undefined;
+    /**
+     * The message template to use for the treatment.
+     */
+    TemplateConfiguration?: TemplateConfiguration | undefined;
+    /**
+     * A custom description of the treatment.
+     */
+    TreatmentDescription?: string | undefined;
+    /**
+     * A custom name for the treatment.
+     */
+    TreatmentName?: string | undefined;
+};
+export type PinpointCampaignAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the campaign.
+     */
+    Arn: string;
+    /**
+     * The unique identifier for the campaign.
+     */
+    CampaignId: string;
+};
+/**
+ * Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
+ */
+export type CampaignCustomMessage = {
+    /**
+     * The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
+     */
+    Data?: string | undefined;
+};
+/**
+ * Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
+ */
+export type CampaignEmailMessage = {
+    /**
+     * The body of the email for recipients whose email clients don't render HTML content.
+     */
+    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.
+     */
+    FromAddress?: string | undefined;
+    /**
+     * The body of the email, in HTML format, for recipients whose email clients render HTML content.
+     */
+    HtmlBody?: string | undefined;
+    /**
+     * The subject line, or title, of the email.
+     */
+    Title?: string | undefined;
+};
+/**
+ * Specifies the settings for events that cause a campaign to be sent.
+ */
+export type CampaignEventFilter = {
+    /**
+     * The dimension settings of the event filter for the campaign.
+     */
+    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.
+     */
+    FilterType?: string | undefined;
+};
+/**
+ * Specifies settings for invoking an Lambda function that customizes a segment for a campaign.
+ */
+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.
+     */
+    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.
+     */
+    Mode?: string | undefined;
+    /**
+     * The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
+     */
+    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.
+ */
+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.
+     */
+    Content?: InAppMessageContent[] | undefined;
+    /**
+     * Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
+     */
+    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.
+     */
+    Layout?: string | undefined;
+};
+/**
+ * Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
+ */
+export type CampaignSmsMessage = {
+    /**
+     * The body of the SMS message.
+     */
+    Body?: string | undefined;
+    /**
+     * The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
+     */
+    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).
+     */
+    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.
+     */
+    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) .
+     */
+    SenderId?: string | undefined;
+    /**
+     * The template ID received from the regulatory body for sending SMS in your country.
+     */
+    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.
+ */
+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.
+     */
+    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.
+     */
+    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.
+ */
+export type DefaultButtonConfiguration = {
+    /**
+     * The background color of a button, expressed as a hex color code (such as #000000 for black).
+     */
+    BackgroundColor?: string | undefined;
+    /**
+     * The border radius of a button.
+     */
+    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.
+     */
+    ButtonAction?: string | undefined;
+    /**
+     * The destination (such as a URL) for a button.
+     */
+    Link?: string | undefined;
+    /**
+     * The text that appears on a button in an in-app message.
+     */
+    Text?: string | undefined;
+    /**
+     * The color of the body text in a button, expressed as a hex color code (such as #000000 for black).
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
+ */
+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.
+     */
+    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* .
+     */
+    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.
+     */
+    Metrics?: Record<string, unknown> | undefined;
+};
+/**
+ * Specifies the configuration of main body text of the in-app message.
+ */
+export type InAppMessageBodyConfig = {
+    /**
+     * The text alignment of the main body text of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     */
+    Alignment?: string | undefined;
+    /**
+     * The main body text of the message.
+     */
+    Body?: string | undefined;
+    /**
+     * The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the configuration of a button that appears in an in-app message.
+ */
+export type InAppMessageButton = {
+    /**
+     * An object that defines the default behavior for a button in in-app messages sent to Android.
+     */
+    Android?: OverrideButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in an in-app message.
+     */
+    DefaultConfig?: DefaultButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in in-app messages sent to iOS devices.
+     */
+    IOS?: OverrideButtonConfiguration | undefined;
+    /**
+     * An object that defines the default behavior for a button in in-app messages for web applications.
+     */
+    Web?: OverrideButtonConfiguration | undefined;
+};
+/**
+ * Specifies the configuration and contents of an in-app message.
+ */
+export type InAppMessageContent = {
+    /**
+     * The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
+     */
+    BackgroundColor?: string | undefined;
+    /**
+     * Specifies the configuration of main body text in an in-app message template.
+     */
+    BodyConfig?: InAppMessageBodyConfig | undefined;
+    /**
+     * Specifies the configuration and content of the header or title text of the in-app message.
+     */
+    HeaderConfig?: InAppMessageHeaderConfig | undefined;
+    /**
+     * The URL of the image that appears on an in-app message banner.
+     */
+    ImageUrl?: string | undefined;
+    /**
+     * An object that contains configuration information about the primary button in an in-app message.
+     */
+    PrimaryBtn?: InAppMessageButton | undefined;
+    /**
+     * An object that contains configuration information about the secondary button in an in-app message.
+     */
+    SecondaryBtn?: InAppMessageButton | undefined;
+};
+/**
+ * Specifies the configuration and content of the header or title text of the in-app message.
+ */
+export type InAppMessageHeaderConfig = {
+    /**
+     * The text alignment of the title of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     */
+    Alignment?: string | undefined;
+    /**
+     * The header or title text of the in-app message.
+     */
+    Header?: string | undefined;
+    /**
+     * The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the limits on the messages that a campaign can send.
+ */
+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.
+     */
+    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.
+     */
+    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.
+     */
+    MessagesPerSecond?: number | undefined;
+    /**
+     * The maximum number of messages that the campaign can send per user 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.
+     */
+    Total?: number | undefined;
+};
+/**
+ * Specifies the content and settings for a push notification that's sent to recipients of a campaign.
+ */
+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.
+     */
+    Action?: string | undefined;
+    /**
+     * The body of the notification message. The maximum number of characters is 200.
+     */
+    Body?: string | undefined;
+    /**
+     * The URL of the image to display as the push notification icon, such as the icon for the app.
+     */
+    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.
+     */
+    ImageSmallIconUrl?: string | undefined;
+    /**
+     * The URL of an image to display in the push notification.
+     */
+    ImageUrl?: string | undefined;
+    /**
+     * The JSON payload to use for a silent push notification.
+     */
+    JsonBody?: string | undefined;
+    /**
+     * The URL of the image or video to display in the push notification.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    TimeToLive?: number | undefined;
+    /**
+     * The title to display above the notification message on a recipient's device.
+     */
+    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` .
+     */
+    Url?: string | undefined;
+};
+/**
+ * Specifies the message configuration settings for a campaign.
+ */
+export type MessageConfiguration = {
+    /**
+     * The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
+     */
+    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.
+     */
+    APNSMessage?: Message | undefined;
+    /**
+     * The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
+     */
+    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.
+     */
+    CustomMessage?: CampaignCustomMessage | undefined;
+    /**
+     * The default message that the campaign sends through all the channels that are configured for the campaign.
+     */
+    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.
+     */
+    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.
+     */
+    GCMMessage?: Message | undefined;
+    /**
+     * The default message for the in-app messaging channel. This message overrides the default message ( `DefaultMessage` ).
+     */
+    InAppMessage?: CampaignInAppMessage | undefined;
+    /**
+     * The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
+     */
+    SMSMessage?: CampaignSmsMessage | undefined;
+};
+/**
+ * Specifies the configuration of a button with settings that are specific to a certain device type.
+ */
+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.
+     */
+    ButtonAction?: string | undefined;
+    /**
+     * The destination (such as a URL) for a button.
+     */
+    Link?: string | undefined;
+};
+/**
+ * Specifies the start and end times that define a time range when messages aren't sent to endpoints.
+ */
+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.
+     */
+    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.
+     */
+    Start: string;
+};
+/**
+ * Specifies the schedule settings for a campaign.
+ */
+export type Schedule = {
+    /**
+     * The scheduled time, in ISO 8601 format, when the campaign ended or will end.
+     */
+    EndTime?: string | undefined;
+    /**
+     * The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` .
+     */
+    EventFilter?: CampaignEventFilter | undefined;
+    /**
+     * Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
+     */
+    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` .
+     */
+    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.
+     */
+    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.
+     */
+    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` .
+     */
+    TimeZone?: string | undefined;
+};
+/**
+ * Specifies the dimension type and values for a segment dimension.
+ */
+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.
+     */
+    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.
+     */
+    Values?: string[] | undefined;
+};
+/**
+ * Specifies the name and version of the message template to use for the message.
+ */
+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.
+     */
+    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.
+     */
+    Version?: string | undefined;
+};
+/**
+ * Specifies the message template to use for the message, for each type of channel.
+ */
+export type TemplateConfiguration = {
+    /**
+     * The email template to use for the message.
+     */
+    EmailTemplate?: Template | undefined;
+    /**
+     * The push notification template to use for the message.
+     */
+    PushTemplate?: Template | undefined;
+    /**
+     * The SMS template to use for the message.
+     */
+    SMSTemplate?: Template | undefined;
+    /**
+     * The voice template to use for the message. This object isn't supported for campaigns.
+     */
+    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.
+ */
+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.
+     */
+    CustomDeliveryConfiguration?: CustomDeliveryConfiguration | undefined;
+    /**
+     * The message configuration settings for the treatment.
+     */
+    MessageConfiguration?: MessageConfiguration | undefined;
+    /**
+     * The schedule settings for the treatment.
+     */
+    Schedule?: Schedule | undefined;
+    /**
+     * The allocated percentage of users (segment members) to send the treatment to.
+     */
+    SizePercent?: number | undefined;
+    /**
+     * The message template to use for the treatment.
+     */
+    TemplateConfiguration?: TemplateConfiguration | undefined;
+    /**
+     * A custom description of the treatment.
+     */
+    TreatmentDescription?: string | undefined;
+    /**
+     * A custom name for the treatment.
+     */
+    TreatmentName?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpoint-campaign.d.ts.map

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

@@ -0,0 +1,44 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointEmailChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::EmailChannel", PinpointEmailChannelProps, PinpointEmailChannelAttribs>;
+/**
+ * A *channel* is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.
+ *
+ * The EmailChannel resource represents the status, identity, and other settings of the email channel for an application
+ */
+export type PinpointEmailChannelProps = {
+    /**
+     * The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
+     */
+    ApplicationId: string;
+    /**
+     * The [Amazon SES configuration set](https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) that you want to apply to messages that you send through the channel.
+     */
+    ConfigurationSet?: string | undefined;
+    /**
+     * Specifies whether to enable the email channel for the application.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The verified email address that you want to send email from when you send email through the channel.
+     */
+    FromAddress: string;
+    /**
+     * The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
+     */
+    Identity: string;
+    /**
+     * The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .
+     */
+    OrchestrationSendingRoleArn?: string | undefined;
+    /**
+     * The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
+     */
+    RoleArn?: string | undefined;
+};
+export type PinpointEmailChannelAttribs = {
+    /**
+     * (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
+     */
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-emailchannel.d.ts.map