@propulsionworks/cloudformation 0.0.2 → 0.1.0

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

@@ -0,0 +1,45 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointEmailTemplate = ResourceDefinitionWithAttributes<"AWS::Pinpoint::EmailTemplate", PinpointEmailTemplateProps, PinpointEmailTemplateAttribs>;
+/**
+ * Creates a message template that you can use in messages that are sent through the email channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.
+ */
+export type PinpointEmailTemplateProps = {
+    /**
+     * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
+     */
+    DefaultSubstitutions?: string | undefined;
+    /**
+     * The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
+     */
+    HtmlPart?: string | undefined;
+    /**
+     * The subject line, or title, to use in email messages that are based on the message template.
+     */
+    Subject: string;
+    /**
+     * 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;
+    /**
+     * A custom description of the message template.
+     */
+    TemplateDescription?: string | undefined;
+    /**
+     * The name of the message template.
+     */
+    TemplateName: string;
+    /**
+     * The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
+     */
+    TextPart?: string | undefined;
+};
+export type PinpointEmailTemplateAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     */
+    Arn: string;
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-emailtemplate.d.ts.map

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

@@ -0,0 +1,27 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointEventStream = ResourceDefinitionWithAttributes<"AWS::Pinpoint::EventStream", PinpointEventStreamProps, PinpointEventStreamAttribs>;
+/**
+ * Creates a new event stream for an application or updates the settings of an existing event stream for an application.
+ */
+export type PinpointEventStreamProps = {
+    /**
+     * The unique identifier for the Amazon Pinpoint application that you want to export data from.
+     */
+    ApplicationId: string;
+    /**
+     * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want to publish event data to.
+     *
+     * For a Kinesis Data Stream, the ARN format is: `arn:aws:kinesis: region : account-id :stream/ stream_name`
+     *
+     * For a Firehose delivery stream, the ARN format is: `arn:aws:firehose: region : account-id :deliverystream/ stream_name`
+     */
+    DestinationStreamArn: string;
+    /**
+     * The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
+     */
+    RoleArn: string;
+};
+export type PinpointEventStreamAttribs = {
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-eventstream.d.ts.map

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

@@ -0,0 +1,36 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointGCMChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::GCMChannel", PinpointGCMChannelProps, PinpointGCMChannelAttribs>;
+/**
+ * A *channel* is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaced the Google Cloud Messaging (GCM) service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application.
+ *
+ * The GCMChannel resource represents the status and authentication settings of the GCM channel for an application.
+ */
+export type PinpointGCMChannelProps = {
+    /**
+     * The Web API key, also called the *server key* , that you received from Google to communicate with Google services.
+     */
+    ApiKey?: string | undefined;
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
+     */
+    ApplicationId: string;
+    /**
+     * The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
+     */
+    DefaultAuthenticationMethod?: string | undefined;
+    /**
+     * Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see [Migrate from legacy FCM APIs to HTTP v1](https://docs.aws.amazon.com/https://firebase.google.com/docs/cloud-messaging/migrate-v1) .
+     */
+    ServiceJson?: string | undefined;
+};
+export type PinpointGCMChannelAttribs = {
+    /**
+     * (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
+     */
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-gcmchannel.d.ts.map

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

@@ -0,0 +1,183 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointInAppTemplate = ResourceDefinitionWithAttributes<"AWS::Pinpoint::InAppTemplate", PinpointInAppTemplateProps, PinpointInAppTemplateAttribs>;
+/**
+ * Creates a message template that you can use to send in-app messages. A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications. The In-App channel is unavailable in AWS GovCloud (US).
+ */
+export type PinpointInAppTemplateProps = {
+    /**
+     * An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.
+     */
+    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 determines the appearance of the in-app message. 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?: "BOTTOM_BANNER" | "TOP_BANNER" | "OVERLAYS" | "MOBILE_FEED" | "MIDDLE_BANNER" | "CAROUSEL" | 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;
+    /**
+     * An optional description of the in-app template.
+     */
+    TemplateDescription?: string | undefined;
+    /**
+     * The name of the in-app message template.
+     */
+    TemplateName: string;
+};
+export type PinpointInAppTemplateAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     */
+    Arn: string;
+};
+export type Alignment = "LEFT" | "CENTER" | "RIGHT";
+/**
+ * Specifies the configuration of the main body text of the in-app message.
+ */
+export type BodyConfig = {
+    /**
+     * The text alignment of the main body text of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     */
+    Alignment?: Alignment | undefined;
+    /**
+     * The main body text of the message.
+     */
+    Body?: string | undefined;
+    /**
+     * The color of the body text, expressed as a hex color code (such as #000000 for black).
+     */
+    TextColor?: string | undefined;
+};
+export type ButtonAction = "LINK" | "DEEP_LINK" | "CLOSE";
+/**
+ * Specifies the behavior of buttons that appear in an in-app message template.
+ */
+export type ButtonConfig = {
+    /**
+     * Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
+     */
+    Android?: OverrideButtonConfiguration | undefined;
+    /**
+     * Specifies the default behavior of 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.
+     */
+    DefaultConfig?: DefaultButtonConfiguration | undefined;
+    /**
+     * Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
+     */
+    IOS?: OverrideButtonConfiguration | undefined;
+    /**
+     * Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.
+     */
+    Web?: OverrideButtonConfiguration | undefined;
+};
+/**
+ * Specifies the default behavior of 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?: ButtonAction | 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 configuration and content of the header or title text of the in-app message.
+ */
+export type HeaderConfig = {
+    /**
+     * The text alignment of the title of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
+     */
+    Alignment?: Alignment | undefined;
+    /**
+     * The title text of the in-app message.
+     */
+    Header?: string | undefined;
+    /**
+     * The color of the title text, expressed as a hex color code (such as #000000 for black).
+     */
+    TextColor?: string | undefined;
+};
+/**
+ * Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.
+ */
+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;
+    /**
+     * An object that contains configuration information about the header or title text of the in-app message.
+     */
+    BodyConfig?: BodyConfig | undefined;
+    /**
+     * An object that contains configuration information about the header or title text of the in-app message.
+     */
+    HeaderConfig?: HeaderConfig | 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?: ButtonConfig | undefined;
+    /**
+     * An object that contains configuration information about the secondary button in an in-app message.
+     */
+    SecondaryBtn?: ButtonConfig | 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?: ButtonAction | undefined;
+    /**
+     * The destination (such as a URL) for a button.
+     */
+    Link?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpoint-inapptemplate.d.ts.map

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

@@ -0,0 +1,158 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointPushTemplate = ResourceDefinitionWithAttributes<"AWS::Pinpoint::PushTemplate", PinpointPushTemplateProps, PinpointPushTemplateAttribs>;
+/**
+ * Creates a message template that you can use in messages that are sent through a push notification channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.
+ */
+export type PinpointPushTemplateProps = {
+    /**
+     * The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels ( `Default` ).
+     */
+    ADM?: AndroidPushNotificationTemplate | undefined;
+    /**
+     * The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels ( `Default` ).
+     */
+    APNS?: APNSPushNotificationTemplate | undefined;
+    /**
+     * The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels ( `Default` ).
+     */
+    Baidu?: AndroidPushNotificationTemplate | undefined;
+    /**
+     * The default message template to use for push notification channels.
+     */
+    Default?: DefaultPushNotificationTemplate | undefined;
+    /**
+     * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
+     */
+    DefaultSubstitutions?: string | undefined;
+    /**
+     * The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels ( `Default` ).
+     */
+    GCM?: AndroidPushNotificationTemplate | 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;
+    /**
+     * A custom description of the message template.
+     */
+    TemplateDescription?: string | undefined;
+    /**
+     * The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
+     */
+    TemplateName: string;
+};
+export type PinpointPushTemplateAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     */
+    Arn: string;
+    Id: string;
+};
+/**
+ * Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.
+ */
+export type APNSPushNotificationTemplate = {
+    /**
+     * The action to occur if a recipient taps a push notification that's based on the message template. 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 the iOS platform.
+     * - `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 message body to use in push notifications that are based on the message template.
+     */
+    Body?: string | undefined;
+    /**
+     * The URL of an image or video to display in push notifications that are based on the message template.
+     */
+    MediaUrl?: string | undefined;
+    /**
+     * The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the `Library/Sounds` folder in your app's data container. If the sound file can't be found or you specify `default` for the value, the system plays the default alert sound.
+     */
+    Sound?: string | undefined;
+    /**
+     * The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
+     */
+    Title?: string | undefined;
+    /**
+     * The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `Action` property is `URL` .
+     */
+    Url?: string | undefined;
+};
+/**
+ * Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
+ */
+export type AndroidPushNotificationTemplate = {
+    /**
+     * The action to occur if a recipient taps a push notification that's based on the message template. 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 action uses the deep-linking features of the Android platform.
+     * - `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 message body to use in a push notification that's based on the message template.
+     */
+    Body?: string | undefined;
+    /**
+     * The URL of the large icon image to display in the content view of a push notification that's based on the message template.
+     */
+    ImageIconUrl?: string | undefined;
+    /**
+     * The URL of an image to display in a push notification that's based on the message template.
+     */
+    ImageUrl?: string | undefined;
+    /**
+     * The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
+     */
+    SmallImageIconUrl?: string | undefined;
+    /**
+     * The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/` .
+     */
+    Sound?: string | undefined;
+    /**
+     * The title to use in a push notification that's based on the message template. This title appears 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 a push notification that's based on the message template and the value of the `Action` property is `URL` .
+     */
+    Url?: string | undefined;
+};
+/**
+ * Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
+ */
+export type DefaultPushNotificationTemplate = {
+    /**
+     * The action to occur if a recipient taps a push notification that's based on the message template. 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 the iOS and Android platforms.
+     * - `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 message body to use in push notifications that are based on the message template.
+     */
+    Body?: string | undefined;
+    /**
+     * The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/` .
+     *
+     * For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the `Library/Sounds` folder in your app's data container. If the sound file can't be found or you specify `default` for the value, the system plays the default alert sound.
+     */
+    Sound?: string | undefined;
+    /**
+     * The title to use in push notifications that are based on the message template. This title appears 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 a push notification that's based on the message template and the value of the `Action` property is `URL` .
+     */
+    Url?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpoint-pushtemplate.d.ts.map

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

@@ -0,0 +1,227 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointSegment = ResourceDefinitionWithAttributes<"AWS::Pinpoint::Segment", PinpointSegmentProps, PinpointSegmentAttribs>;
+/**
+ * Updates the configuration, dimension, and other settings for an existing segment.
+ */
+export type PinpointSegmentProps = {
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the segment is associated with.
+     */
+    ApplicationId: string;
+    /**
+     * An array that defines the dimensions for the segment.
+     */
+    Dimensions?: SegmentDimensions | undefined;
+    /**
+     * The name of the segment.
+     *
+     * > A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
+     */
+    Name: string;
+    /**
+     * The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
+     */
+    SegmentGroups?: SegmentGroups | 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;
+};
+export type PinpointSegmentAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the segment.
+     */
+    Arn: string;
+    /**
+     * The unique identifier for the segment.
+     */
+    SegmentId: string;
+};
+/**
+ * Specifies behavior-based criteria for the segment, such as how recently users have used your app.
+ */
+export type Behavior = {
+    /**
+     * Specifies how recently segment members were active.
+     */
+    Recency?: Recency | undefined;
+};
+/**
+ * Specifies the GPS coordinates of a location.
+ */
+export type Coordinates = {
+    /**
+     * The latitude coordinate of the location.
+     */
+    Latitude: number;
+    /**
+     * The longitude coordinate of the location.
+     */
+    Longitude: number;
+};
+/**
+ * Specifies demographic-based criteria, such as device platform, for the segment.
+ */
+export type Demographic = {
+    /**
+     * The app version criteria for the segment.
+     */
+    AppVersion?: SetDimension | undefined;
+    /**
+     * The channel criteria for the segment.
+     */
+    Channel?: SetDimension | undefined;
+    /**
+     * The device type criteria for the segment.
+     */
+    DeviceType?: SetDimension | undefined;
+    /**
+     * The device make criteria for the segment.
+     */
+    Make?: SetDimension | undefined;
+    /**
+     * The device model criteria for the segment.
+     */
+    Model?: SetDimension | undefined;
+    /**
+     * The device platform criteria for the segment.
+     */
+    Platform?: SetDimension | undefined;
+};
+/**
+ * Specifies the GPS coordinates of the endpoint location.
+ */
+export type GPSPoint = {
+    /**
+     * The GPS coordinates to measure distance from.
+     */
+    Coordinates: Coordinates;
+    /**
+     * The range, in kilometers, from the GPS coordinates.
+     */
+    RangeInKilometers: number;
+};
+/**
+ * An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
+ */
+export type Groups = {
+    /**
+     * An array that defines the dimensions to include or exclude from the segment.
+     */
+    Dimensions?: SegmentDimensions[] | undefined;
+    /**
+     * The base segment to build the segment on. A base segment, also called a *source segment* , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
+     *
+     * You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.
+     */
+    SourceSegments?: SourceSegments[] | undefined;
+    /**
+     * Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
+     */
+    SourceType?: string | undefined;
+    /**
+     * Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
+     */
+    Type?: string | undefined;
+};
+/**
+ * Specifies location-based criteria, such as region or GPS coordinates, for the segment.
+ */
+export type Location = {
+    /**
+     * The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
+     */
+    Country?: SetDimension | undefined;
+    /**
+     * The GPS point dimension for the segment.
+     */
+    GPSPoint?: GPSPoint | undefined;
+};
+/**
+ * Specifies how recently segment members were active.
+ */
+export type Recency = {
+    /**
+     * The duration to use when determining which users have been active or inactive with your app.
+     *
+     * Possible values: `HR_24` | `DAY_7` | `DAY_14` | `DAY_30` .
+     */
+    Duration: string;
+    /**
+     * The type of recency dimension to use for the segment. Valid values are: `ACTIVE` and `INACTIVE` . If the value is `ACTIVE` , the segment includes users who have used your app within the specified duration are included in the segment. If the value is `INACTIVE` , the segment includes users who haven't used your app within the specified duration are included in the segment.
+     */
+    RecencyType: string;
+};
+/**
+ * Specifies the dimension settings for a segment.
+ */
+export type SegmentDimensions = {
+    /**
+     * One or more custom attributes to use as criteria for the segment. For more information see [AttributeDimension](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-segments.html#apps-application-id-segments-model-attributedimension)
+     */
+    Attributes?: Record<string, unknown> | undefined;
+    /**
+     * The behavior-based criteria, such as how recently users have used your app, for the segment.
+     */
+    Behavior?: Behavior | undefined;
+    /**
+     * The demographic-based criteria, such as device platform, for the segment.
+     */
+    Demographic?: Demographic | undefined;
+    /**
+     * The location-based criteria, such as region or GPS coordinates, for the segment.
+     */
+    Location?: Location | undefined;
+    /**
+     * One or more custom metrics to use as criteria for the segment.
+     */
+    Metrics?: Record<string, unknown> | undefined;
+    /**
+     * One or more custom user attributes to use as criteria for the segment.
+     */
+    UserAttributes?: Record<string, unknown> | undefined;
+};
+/**
+ * Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
+ */
+export type SegmentGroups = {
+    /**
+     * Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
+     */
+    Groups?: Groups[] | undefined;
+    /**
+     * Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
+     */
+    Include?: 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 base segment to build the segment on. A base segment, also called a *source segment* , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
+ *
+ * You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.
+ */
+export type SourceSegments = {
+    /**
+     * The unique identifier for the source segment.
+     */
+    Id: string;
+    /**
+     * The version number of the source segment.
+     */
+    Version?: number | undefined;
+};
+//# sourceMappingURL=aws-pinpoint-segment.d.ts.map