@propulsionworks/cloudformation 0.1.0 → 0.1.2

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

@@ -1,57 +1,79 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html}
+ */
 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html}
  */
 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` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-adm}
      */
     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` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-apns}
      */
     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` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-baidu}
      */
     Baidu?: AndroidPushNotificationTemplate | undefined;
     /**
      * The default message template to use for push notification channels.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-default}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-defaultsubstitutions}
      */
     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` ).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-gcm}
      */
     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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-tags}
      */
     Tags?: Record<string, unknown> | undefined;
     /**
      * A custom description of the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatedescription}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatename}
      */
     TemplateName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#aws-resource-pinpoint-pushtemplate-return-values}
+ */
 export type PinpointPushTemplateAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-arn}
      */
     Arn: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-id}
+     */
     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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html}
  */
 export type APNSPushNotificationTemplate = {
     /**
@@ -60,31 +82,38 @@ export type APNSPushNotificationTemplate = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action}
      */
     Action?: string | undefined;
     /**
      * The message body to use in push notifications that are based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body}
      */
     Body?: string | undefined;
     /**
      * The URL of an image or video to display in push notifications that are based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html}
  */
 export type AndroidPushNotificationTemplate = {
     /**
@@ -93,39 +122,48 @@ export type AndroidPushNotificationTemplate = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-action}
      */
     Action?: string | undefined;
     /**
      * The message body to use in a push notification that's based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-body}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageiconurl}
      */
     ImageIconUrl?: string | undefined;
     /**
      * The URL of an image to display in a push notification that's based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageurl}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-smallimageiconurl}
      */
     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/` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-sound}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-title}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html}
  */
 export type DefaultPushNotificationTemplate = {
     /**
@@ -134,24 +172,29 @@ export type DefaultPushNotificationTemplate = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-action}
      */
     Action?: string | undefined;
     /**
      * The message body to use in push notifications that are based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-body}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-title}
      */
     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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-url}
      */
     Url?: string | undefined;
 };

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

@@ -1,211 +1,265 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Updates the configuration, dimension, and other settings for an existing segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html}
+ */
 export type PinpointSegment = ResourceDefinitionWithAttributes<"AWS::Pinpoint::Segment", PinpointSegmentProps, PinpointSegmentAttribs>;
 /**
  * Updates the configuration, dimension, and other settings for an existing segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html}
  */
 export type PinpointSegmentProps = {
     /**
      * The unique identifier for the Amazon Pinpoint application that the segment is associated with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid}
      */
     ApplicationId: string;
     /**
      * An array that defines the dimensions for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions}
      */
     Dimensions?: SegmentDimensions | undefined;
     /**
      * The name of the segment.
      *
      * > A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-name}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups}
      */
     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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags}
      */
     Tags?: Record<string, unknown> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#aws-resource-pinpoint-segment-return-values}
+ */
 export type PinpointSegmentAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-arn}
      */
     Arn: string;
     /**
      * The unique identifier for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentid}
      */
     SegmentId: string;
 };
 /**
  * Specifies behavior-based criteria for the segment, such as how recently users have used your app.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-behavior.html}
  */
 export type Behavior = {
     /**
      * Specifies how recently segment members were active.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-behavior.html#cfn-pinpoint-segment-behavior-recency}
      */
     Recency?: Recency | undefined;
 };
 /**
  * Specifies the GPS coordinates of a location.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html}
  */
 export type Coordinates = {
     /**
      * The latitude coordinate of the location.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-latitude}
      */
     Latitude: number;
     /**
      * The longitude coordinate of the location.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-longitude}
      */
     Longitude: number;
 };
 /**
  * Specifies demographic-based criteria, such as device platform, for the segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html}
  */
 export type Demographic = {
     /**
      * The app version criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-appversion}
      */
     AppVersion?: SetDimension | undefined;
     /**
      * The channel criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-channel}
      */
     Channel?: SetDimension | undefined;
     /**
      * The device type criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-devicetype}
      */
     DeviceType?: SetDimension | undefined;
     /**
      * The device make criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-make}
      */
     Make?: SetDimension | undefined;
     /**
      * The device model criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-model}
      */
     Model?: SetDimension | undefined;
     /**
      * The device platform criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-platform}
      */
     Platform?: SetDimension | undefined;
 };
 /**
  * Specifies the GPS coordinates of the endpoint location.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html}
  */
 export type GPSPoint = {
     /**
      * The GPS coordinates to measure distance from.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-coordinates}
      */
     Coordinates: Coordinates;
     /**
      * The range, in kilometers, from the GPS coordinates.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-rangeinkilometers}
      */
     RangeInKilometers: number;
 };
 /**
  * An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html}
  */
 export type Groups = {
     /**
      * An array that defines the dimensions to include or exclude from the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-dimensions}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcesegments}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcetype}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-type}
      */
     Type?: string | undefined;
 };
 /**
  * Specifies location-based criteria, such as region or GPS coordinates, for the segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html}
  */
 export type Location = {
     /**
      * The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-country}
      */
     Country?: SetDimension | undefined;
     /**
      * The GPS point dimension for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-gpspoint}
      */
     GPSPoint?: GPSPoint | undefined;
 };
 /**
  * Specifies how recently segment members were active.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html}
  */
 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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-duration}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-recencytype}
      */
     RecencyType: string;
 };
 /**
  * Specifies the dimension settings for a segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html}
  */
 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)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-attributes}
      */
     Attributes?: Record<string, unknown> | undefined;
     /**
      * The behavior-based criteria, such as how recently users have used your app, for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-behavior}
      */
     Behavior?: Behavior | undefined;
     /**
      * The demographic-based criteria, such as device platform, for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-demographic}
      */
     Demographic?: Demographic | undefined;
     /**
      * The location-based criteria, such as region or GPS coordinates, for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-location}
      */
     Location?: Location | undefined;
     /**
      * One or more custom metrics to use as criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-metrics}
      */
     Metrics?: Record<string, unknown> | undefined;
     /**
      * One or more custom user attributes to use as criteria for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-userattributes}
      */
     UserAttributes?: Record<string, unknown> | undefined;
 };
 /**
  * Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html}
  */
 export type SegmentGroups = {
     /**
      * Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-groups}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-include}
      */
     Include?: 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-segment-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-segment-setdimension.html#cfn-pinpoint-segment-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-segment-setdimension.html#cfn-pinpoint-segment-setdimension-values}
      */
     Values?: string[] | undefined;
 };
@@ -213,14 +267,17 @@ export type SetDimension = {
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html}
  */
 export type SourceSegments = {
     /**
      * The unique identifier for the source segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-id}
      */
     Id: string;
     /**
      * The version number of the source segment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-version}
      */
     Version?: number | undefined;
 };

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

@@ -1,35 +1,50 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.
+ *
+ * The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html}
+ */
 export type PinpointSMSChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::SMSChannel", PinpointSMSChannelProps, PinpointSMSChannelAttribs>;
 /**
  * A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.
  *
  * The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html}
  */
 export type PinpointSMSChannelProps = {
     /**
      * The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid}
      */
     ApplicationId: string;
     /**
      * Specifies whether to enable the SMS channel for the application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled}
      */
     Enabled?: boolean | undefined;
     /**
      * The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
      *
      * > SenderIDs are only supported in certain countries and regions. For more information, see [Supported Countries and Regions](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) in the *Amazon Pinpoint User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid}
      */
     SenderId?: string | undefined;
     /**
      * The registered short code that you want to use when you send messages through the SMS channel.
      *
      * > For information about obtaining a dedicated short code for sending SMS messages, see [Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html) in the *Amazon Pinpoint User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode}
      */
     ShortCode?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#aws-resource-pinpoint-smschannel-return-values}
+ */
 export type PinpointSMSChannelAttribs = {
     /**
      * (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-id}
      */
     Id: string;
 };

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

@@ -1,37 +1,54 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a message template that you can use in messages that are sent through the SMS 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html}
+ */
 export type PinpointSmsTemplate = ResourceDefinitionWithAttributes<"AWS::Pinpoint::SmsTemplate", PinpointSmsTemplateProps, PinpointSmsTemplateAttribs>;
 /**
  * Creates a message template that you can use in messages that are sent through the SMS 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html}
  */
 export type PinpointSmsTemplateProps = {
     /**
      * The message body to use in text messages that are based on the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-body}
      */
     Body: string;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-defaultsubstitutions}
      */
     DefaultSubstitutions?: string | 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-smstemplate.html#cfn-pinpoint-smstemplate-tags}
      */
     Tags?: Record<string, unknown> | undefined;
     /**
      * A custom description of the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatedescription}
      */
     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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatename}
      */
     TemplateName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#aws-resource-pinpoint-smstemplate-return-values}
+ */
 export type PinpointSmsTemplateAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the message template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-arn}
      */
     Arn: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-pinpoint-smstemplate.d.ts.map

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

@@ -1,23 +1,36 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.
+ *
+ * The VoiceChannel resource represents the status and other information about the voice channel for an application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html}
+ */
 export type PinpointVoiceChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::VoiceChannel", PinpointVoiceChannelProps, PinpointVoiceChannelAttribs>;
 /**
  * A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.
  *
  * The VoiceChannel resource represents the status and other information about the voice channel for an application.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html}
  */
 export type PinpointVoiceChannelProps = {
     /**
      * The unique identifier for the Amazon Pinpoint application that the voice channel applies to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-applicationid}
      */
     ApplicationId: string;
     /**
      * Specifies whether to enable the voice channel for the application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-enabled}
      */
     Enabled?: boolean | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#aws-resource-pinpoint-voicechannel-return-values}
+ */
 export type PinpointVoiceChannelAttribs = {
     /**
      * (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-id}
      */
     Id: string;
 };