@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-customerprofiles-objecttype.d.ts

@@ -1,17 +1,24 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies an Amazon Connect Customer Profiles Object Type Mapping.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html}
+ */
 export type CustomerProfilesObjectType = ResourceDefinitionWithAttributes<"AWS::CustomerProfiles::ObjectType", CustomerProfilesObjectTypeProps, CustomerProfilesObjectTypeAttribs>;
 /**
  * Specifies an Amazon Connect Customer Profiles Object Type Mapping.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html}
  */
 export type CustomerProfilesObjectTypeProps = {
     /**
      * Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE` . If the AllowProfileCreation flag is set to `FALSE` , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE` , and if no match is found, then the service creates a new standard profile.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-allowprofilecreation}
      */
     AllowProfileCreation?: boolean | undefined;
     /**
      * The description of the profile object type mapping.
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-description}
      */
     Description: string;
     /**
@@ -19,26 +26,31 @@ export type CustomerProfilesObjectTypeProps = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-domainname}
      */
     DomainName: string;
     /**
      * The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. If not specified the system will use the encryption key of the domain.
      * @minLength 0
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-encryptionkey}
      */
     EncryptionKey?: string | undefined;
     /**
      * The number of days until the data of this type expires.
      * @min 1
      * @max 1098
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-expirationdays}
      */
     ExpirationDays?: number | undefined;
     /**
      * A list of field definitions for the object type mapping.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-fields}
      */
     Fields?: FieldMap[] | undefined;
     /**
      * A list of keys that can be used to map data to the profile or search for the profile.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-keys}
      */
     Keys?: KeyMap[] | undefined;
     /**
@@ -46,16 +58,19 @@ export type CustomerProfilesObjectTypeProps = {
      * @minLength 1
      * @maxLength 255
      * @pattern ^[a-zA-Z_][a-zA-Z_0-9-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-objecttypename}
      */
     ObjectTypeName: string;
     /**
      * The format of your sourceLastUpdatedTimestamp that was previously set up.
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-sourcelastupdatedtimestampformat}
      */
     SourceLastUpdatedTimestampFormat?: string | undefined;
     /**
      * The tags used to organize, track, or control access for this resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -63,21 +78,28 @@ export type CustomerProfilesObjectTypeProps = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-templateid}
      */
     TemplateId?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#aws-resource-customerprofiles-objecttype-return-values}
+ */
 export type CustomerProfilesObjectTypeAttribs = {
     /**
      * The timestamp of when the object type was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-createdat}
      */
     CreatedAt: string;
     /**
      * The timestamp of when the object type was most recently edited.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-lastupdatedat}
      */
     LastUpdatedAt: string;
 };
 /**
  * A map of the name and ObjectType field.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html}
  */
 export type FieldMap = {
     /**
@@ -85,15 +107,18 @@ export type FieldMap = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-name}
      */
     Name?: string | undefined;
     /**
      * Represents a field in a ProfileObjectType.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-objecttypefield}
      */
     ObjectTypeField?: ObjectTypeField | undefined;
 };
 /**
  * A unique key map that can be used to map data to the profile.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html}
  */
 export type KeyMap = {
     /**
@@ -101,44 +126,53 @@ export type KeyMap = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-name}
      */
     Name?: string | undefined;
     /**
      * A list of ObjectTypeKey.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-objecttypekeylist}
      */
     ObjectTypeKeyList?: ObjectTypeKey[] | undefined;
 };
 /**
  * Represents a field in a ProfileObjectType.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html}
  */
 export type ObjectTypeField = {
     /**
      * The content type of the field. Used for determining equality when searching.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-contenttype}
      */
     ContentType?: "STRING" | "NUMBER" | "PHONE_NUMBER" | "EMAIL_ADDRESS" | "NAME" | undefined;
     /**
      * A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-source}
      */
     Source?: string | undefined;
     /**
      * The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-target}
      */
     Target?: string | undefined;
 };
 /**
  * An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html}
  */
 export type ObjectTypeKey = {
     /**
      * The reference for the key name of the fields map.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-fieldnames}
      */
     FieldNames?: string[] | undefined;
     /**
      * The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers}
      */
     StandardIdentifiers?: ("PROFILE" | "UNIQUE" | "SECONDARY" | "LOOKUP_ONLY" | "NEW_ONLY" | "ASSET" | "CASE" | "ORDER")[] | undefined;
 };

package/out/exports/resources.generated/aws-customerprofiles-segmentdefinition.d.ts

@@ -1,19 +1,26 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * A segment definition resource of Amazon Connect Customer Profiles.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html}
+ */
 export type CustomerProfilesSegmentDefinition = ResourceDefinitionWithAttributes<"AWS::CustomerProfiles::SegmentDefinition", CustomerProfilesSegmentDefinitionProps, CustomerProfilesSegmentDefinitionAttribs>;
 /**
  * A segment definition resource of Amazon Connect Customer Profiles.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html}
  */
 export type CustomerProfilesSegmentDefinitionProps = {
     /**
      * The description of the segment definition.
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-description}
      */
     Description?: string | undefined;
     /**
      * Display name of the segment definition.
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-displayname}
      */
     DisplayName: string;
     /**
@@ -21,6 +28,7 @@ export type CustomerProfilesSegmentDefinitionProps = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-domainname}
      */
     DomainName: string;
     /**
@@ -28,121 +36,151 @@ export type CustomerProfilesSegmentDefinitionProps = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionname}
      */
     SegmentDefinitionName: string;
     /**
      * Contains all groups of the segment definition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentgroups}
      */
     SegmentGroups: SegmentGroup;
     /**
      * The tags belonging to the segment definition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#aws-resource-customerprofiles-segmentdefinition-return-values}
+ */
 export type CustomerProfilesSegmentDefinitionAttribs = {
     /**
      * When the segment definition was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-createdat}
      */
     CreatedAt: string;
     /**
      * The arn of the segment definition.
      * @minLength 1
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionarn}
      */
     SegmentDefinitionArn: string;
 };
 /**
  * Object that segments on Customer Profile's address object.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html}
  */
 export type AddressDimension = {
     /**
      * The city belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-city}
      */
     City?: ProfileDimension | undefined;
     /**
      * The country belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-country}
      */
     Country?: ProfileDimension | undefined;
     /**
      * The county belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-county}
      */
     County?: ProfileDimension | undefined;
     /**
      * The postal code belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode}
      */
     PostalCode?: ProfileDimension | undefined;
     /**
      * The province belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-province}
      */
     Province?: ProfileDimension | undefined;
     /**
      * The state belonging to the address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-state}
      */
     State?: ProfileDimension | undefined;
 };
 /**
  * Object that defines how to filter the incoming objects for the calculated attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html}
  */
 export type AttributeDimension = {
     /**
      * The action to segment with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype}
      */
     DimensionType: AttributeDimensionType;
     /**
      * The values to apply the DimensionType on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-values}
      */
     Values: string[];
 };
 /**
  * The type of segment dimension to use.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimensiontype.html}
  */
 export type AttributeDimensionType = "INCLUSIVE" | "EXCLUSIVE" | "CONTAINS" | "BEGINS_WITH" | "ENDS_WITH" | "BEFORE" | "AFTER" | "BETWEEN" | "NOT_BETWEEN" | "ON" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL" | "EQUAL";
 /**
  * Object that segments on Customer Profile's Calculated Attributes.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html}
  */
 export type CalculatedAttributeDimension = {
     /**
      * Applies the given condition over the initial Calculated Attribute's definition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides}
      */
     ConditionOverrides?: ConditionOverrides | undefined;
     /**
      * The action to segment with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype}
      */
     DimensionType: AttributeDimensionType;
     /**
      * The values to apply the DimensionType with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values}
      */
     Values: string[];
 };
 /**
  * An object to override the original condition block of a calculated attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html}
  */
 export type ConditionOverrides = {
     /**
      * The relative time period over which data is included in the aggregation for this override.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html#cfn-customerprofiles-segmentdefinition-conditionoverrides-range}
      */
     Range?: RangeOverride | undefined;
 };
 /**
  * Object that segments on various Customer Profile's date fields.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html}
  */
 export type DateDimension = {
     /**
      * The action to segment on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype}
      */
     DimensionType: DateDimensionType;
     /**
      * The values to apply the DimensionType on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-values}
      */
     Values: string[];
 };
 /**
  * The type of segment dimension to use for a date dimension.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimensiontype.html}
  */
 export type DateDimensionType = "BEFORE" | "AFTER" | "BETWEEN" | "NOT_BETWEEN" | "ON";
 /**
  * Defines the attribute to segment on.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html}
  */
 export type Dimension = {
     ProfileAttributes: ProfileAttributes;
@@ -151,177 +189,221 @@ export type Dimension = {
 };
 /**
  * Object that segments on various Customer profile's fields that are larger than normal.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html}
  */
 export type ExtraLengthValueProfileDimension = {
     /**
      * The action to segment with.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype}
      */
     DimensionType: StringDimensionType;
     /**
      * The values to apply the DimensionType on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values}
      */
     Values: string[];
 };
 /**
  * Contains dimensions that determine what to segment on.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html}
  */
 export type Group = {
     /**
      * Defines the attributes to segment on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-dimensions}
      */
     Dimensions?: Dimension[] | undefined;
     /**
      * Defines the starting source of data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcesegments}
      */
     SourceSegments?: SourceSegment[] | undefined;
     /**
      * Defines how to interact with the source data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcetype}
      */
     SourceType?: IncludeOptions | undefined;
     /**
      * Defines how to interact with the profiles found in the current filtering.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-type}
      */
     Type?: IncludeOptions | undefined;
 };
 /**
  * Specifies the operator on how to handle multiple groups within the same segment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-includeoptions.html}
  */
 export type IncludeOptions = "ALL" | "ANY" | "NONE";
 /**
  * The object used to segment on attributes within the customer profile.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html}
  */
 export type ProfileAttributes = {
     /**
      * A field to describe values to segment on within account number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber}
      */
     AccountNumber?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within additional information.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation}
      */
     AdditionalInformation?: ExtraLengthValueProfileDimension | undefined;
     /**
      * A field to describe values to segment on within address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-address}
      */
     Address?: AddressDimension | undefined;
     /**
      * A field to describe values to segment on within attributes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-attributes}
      */
     Attributes?: Record<string, AttributeDimension> | undefined;
     /**
      * A field to describe values to segment on within billing address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress}
      */
     BillingAddress?: AddressDimension | undefined;
     /**
      * A field to describe values to segment on within birthDate.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate}
      */
     BirthDate?: DateDimension | undefined;
     /**
      * A field to describe values to segment on within business email address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress}
      */
     BusinessEmailAddress?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within business name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessname}
      */
     BusinessName?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within business phone number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber}
      */
     BusinessPhoneNumber?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within email address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress}
      */
     EmailAddress?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within first name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-firstname}
      */
     FirstName?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within genderString.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring}
      */
     GenderString?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within home phone number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber}
      */
     HomePhoneNumber?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within last name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-lastname}
      */
     LastName?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within mailing address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress}
      */
     MailingAddress?: AddressDimension | undefined;
     /**
      * A field to describe values to segment on within middle name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-middlename}
      */
     MiddleName?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within mobile phone number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber}
      */
     MobilePhoneNumber?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within partyTypeString.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring}
      */
     PartyTypeString?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within personal email address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress}
      */
     PersonalEmailAddress?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within phone number.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber}
      */
     PhoneNumber?: ProfileDimension | undefined;
     /**
      * A field to describe values to segment on within shipping address.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress}
      */
     ShippingAddress?: AddressDimension | undefined;
 };
 /**
  * Object that segments on various Customer profile's fields that are larger than normal.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html}
  */
 export type ProfileDimension = {
     /**
      * The action to segment on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype}
      */
     DimensionType: StringDimensionType;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-values}
+     */
     Values: string[];
 };
 /**
  * Overrides the original range on a calculated attribute definition.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html}
  */
 export type RangeOverride = {
     /**
      * The end time of when to include objects.
      * @min 0
      * @max 366
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-end}
      */
     End?: number | undefined;
     /**
      * The start time of when to include objects.
      * @min 1
      * @max 366
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-start}
      */
     Start: number;
     /**
      * The unit for start and end.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-unit}
      */
     Unit: "DAYS";
 };
 /**
  * Contains all groups of the segment definition.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html}
  */
 export type SegmentGroup = {
     /**
      * Holds the list of groups within the segment definition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-groups}
      */
     Groups?: Group[] | undefined;
     /**
      * Defines whether to include or exclude the profiles that fit the segment criteria.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-include}
      */
     Include?: IncludeOptions | undefined;
 };
 /**
  * The source segments to build off of.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.html}
  */
 export type SourceSegment = {
     /**
@@ -329,11 +411,13 @@ export type SourceSegment = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.html#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname}
      */
     SegmentDefinitionName?: string | undefined;
 };
 /**
  * The type of segment dimension to use for a string dimension.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-stringdimensiontype.html}
  */
 export type StringDimensionType = "INCLUSIVE" | "EXCLUSIVE" | "CONTAINS" | "BEGINS_WITH" | "ENDS_WITH";
 //# sourceMappingURL=aws-customerprofiles-segmentdefinition.d.ts.map