This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::CustomerProfiles::SegmentDefinition
<a name="aws-resource-customerprofiles-segmentdefinition"></a>

A segment definition resource of Amazon Connect Customer Profiles.

## Syntax
<a name="aws-resource-customerprofiles-segmentdefinition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-customerprofiles-segmentdefinition-syntax.json"></a>

```
{
  "Type" : "AWS::CustomerProfiles::SegmentDefinition",
  "Properties" : {
      "[Description](#cfn-customerprofiles-segmentdefinition-description)" : String,
      "[DisplayName](#cfn-customerprofiles-segmentdefinition-displayname)" : String,
      "[DomainName](#cfn-customerprofiles-segmentdefinition-domainname)" : String,
      "[SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-segmentdefinitionname)" : String,
      "[SegmentGroups](#cfn-customerprofiles-segmentdefinition-segmentgroups)" : SegmentGroup,
      "[SegmentSort](#cfn-customerprofiles-segmentdefinition-segmentsort)" : SegmentSort,
      "[SegmentSqlQuery](#cfn-customerprofiles-segmentdefinition-segmentsqlquery)" : String,
      "[Tags](#cfn-customerprofiles-segmentdefinition-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-customerprofiles-segmentdefinition-syntax.yaml"></a>

```
Type: AWS::CustomerProfiles::SegmentDefinition
Properties:
  [Description](#cfn-customerprofiles-segmentdefinition-description): String
  [DisplayName](#cfn-customerprofiles-segmentdefinition-displayname): String
  [DomainName](#cfn-customerprofiles-segmentdefinition-domainname): String
  [SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-segmentdefinitionname): String
  [SegmentGroups](#cfn-customerprofiles-segmentdefinition-segmentgroups): 
    SegmentGroup
  [SegmentSort](#cfn-customerprofiles-segmentdefinition-segmentsort): 
    SegmentSort
  [SegmentSqlQuery](#cfn-customerprofiles-segmentdefinition-segmentsqlquery): String
  [Tags](#cfn-customerprofiles-segmentdefinition-tags): 
    - Tag
```

## Properties
<a name="aws-resource-customerprofiles-segmentdefinition-properties"></a>

`Description`  <a name="cfn-customerprofiles-segmentdefinition-description"></a>
The description of the segment definition.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `4000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisplayName`  <a name="cfn-customerprofiles-segmentdefinition-displayname"></a>
Display name of the segment definition.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DomainName`  <a name="cfn-customerprofiles-segmentdefinition-domainname"></a>
The name of the domain.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SegmentDefinitionName`  <a name="cfn-customerprofiles-segmentdefinition-segmentdefinitionname"></a>
Name of the segment definition.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SegmentGroups`  <a name="cfn-customerprofiles-segmentdefinition-segmentgroups"></a>
Contains all groups of the segment definition.  
*Required*: No  
*Type*: [SegmentGroup](aws-properties-customerprofiles-segmentdefinition-segmentgroup.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SegmentSort`  <a name="cfn-customerprofiles-segmentdefinition-segmentsort"></a>
Property description not available.  
*Required*: No  
*Type*: [SegmentSort](aws-properties-customerprofiles-segmentdefinition-segmentsort.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SegmentSqlQuery`  <a name="cfn-customerprofiles-segmentdefinition-segmentsqlquery"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `50000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-customerprofiles-segmentdefinition-tags"></a>
The tags belonging to the segment definition.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-customerprofiles-segmentdefinition-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-customerprofiles-segmentdefinition-return-values"></a>

### Ref
<a name="aws-resource-customerprofiles-segmentdefinition-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-customerprofiles-segmentdefinition-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-customerprofiles-segmentdefinition-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
When the segment definition was created.

`SegmentDefinitionArn`  <a name="SegmentDefinitionArn-fn::getatt"></a>
The arn of the segment definition.

`SegmentType`  <a name="SegmentType-fn::getatt"></a>
The segment type.  
 Classic : Segments created using traditional SegmentGroup structure  
 Enhanced : Segments created using SQL queries 

# AWS::CustomerProfiles::SegmentDefinition AddressDimension
<a name="aws-properties-customerprofiles-segmentdefinition-addressdimension"></a>

Object that segments on Customer Profile's address object.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-addressdimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-addressdimension-syntax.json"></a>

```
{
  "[City](#cfn-customerprofiles-segmentdefinition-addressdimension-city)" : ProfileDimension,
  "[Country](#cfn-customerprofiles-segmentdefinition-addressdimension-country)" : ProfileDimension,
  "[County](#cfn-customerprofiles-segmentdefinition-addressdimension-county)" : ProfileDimension,
  "[PostalCode](#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode)" : ProfileDimension,
  "[Province](#cfn-customerprofiles-segmentdefinition-addressdimension-province)" : ProfileDimension,
  "[State](#cfn-customerprofiles-segmentdefinition-addressdimension-state)" : ProfileDimension
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-addressdimension-syntax.yaml"></a>

```
  [City](#cfn-customerprofiles-segmentdefinition-addressdimension-city): 
    ProfileDimension
  [Country](#cfn-customerprofiles-segmentdefinition-addressdimension-country): 
    ProfileDimension
  [County](#cfn-customerprofiles-segmentdefinition-addressdimension-county): 
    ProfileDimension
  [PostalCode](#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode): 
    ProfileDimension
  [Province](#cfn-customerprofiles-segmentdefinition-addressdimension-province): 
    ProfileDimension
  [State](#cfn-customerprofiles-segmentdefinition-addressdimension-state): 
    ProfileDimension
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-addressdimension-properties"></a>

`City`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-city"></a>
The city belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Country`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-country"></a>
The country belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`County`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-county"></a>
The county belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PostalCode`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-postalcode"></a>
The postal code belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Province`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-province"></a>
The province belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`State`  <a name="cfn-customerprofiles-segmentdefinition-addressdimension-state"></a>
The state belonging to the address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition AttributeDimension
<a name="aws-properties-customerprofiles-segmentdefinition-attributedimension"></a>

Object that defines how to filter the incoming objects for the calculated attribute.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-attributedimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-attributedimension-syntax.json"></a>

```
{
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-attributedimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-attributedimension-syntax.yaml"></a>

```
  [DimensionType](#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-attributedimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-attributedimension-properties"></a>

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype"></a>
The action to segment with.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `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`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-attributedimension-values"></a>
The values to apply the DimensionType on.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `255 | 50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition CalculatedAttributeDimension
<a name="aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension"></a>

Object that segments on Customer Profile's Calculated Attributes.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension-syntax.json"></a>

```
{
  "[ConditionOverrides](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides)" : ConditionOverrides,
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension-syntax.yaml"></a>

```
  [ConditionOverrides](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides): 
    ConditionOverrides
  [DimensionType](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension-properties"></a>

`ConditionOverrides`  <a name="cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides"></a>
Applies the given condition over the initial Calculated Attribute's definition.  
*Required*: No  
*Type*: [ConditionOverrides](aws-properties-customerprofiles-segmentdefinition-conditionoverrides.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype"></a>
The action to segment with.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `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`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values"></a>
The values to apply the DimensionType with.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `255 | 50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition ConditionOverrides
<a name="aws-properties-customerprofiles-segmentdefinition-conditionoverrides"></a>

An object to override the original condition block of a calculated attribute.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-conditionoverrides-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-conditionoverrides-syntax.json"></a>

```
{
  "[Range](#cfn-customerprofiles-segmentdefinition-conditionoverrides-range)" : RangeOverride
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-conditionoverrides-syntax.yaml"></a>

```
  [Range](#cfn-customerprofiles-segmentdefinition-conditionoverrides-range): 
    RangeOverride
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-conditionoverrides-properties"></a>

`Range`  <a name="cfn-customerprofiles-segmentdefinition-conditionoverrides-range"></a>
The relative time period over which data is included in the aggregation for this override.  
*Required*: No  
*Type*: [RangeOverride](aws-properties-customerprofiles-segmentdefinition-rangeoverride.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition DateDimension
<a name="aws-properties-customerprofiles-segmentdefinition-datedimension"></a>

Object that segments on various Customer Profile's date fields.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-datedimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-datedimension-syntax.json"></a>

```
{
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-datedimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-datedimension-syntax.yaml"></a>

```
  [DimensionType](#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-datedimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-datedimension-properties"></a>

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype"></a>
The action to segment on.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `BEFORE | AFTER | BETWEEN | NOT_BETWEEN | ON`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-datedimension-values"></a>
The values to apply the DimensionType on.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition Dimension
<a name="aws-properties-customerprofiles-segmentdefinition-dimension"></a>

Defines the attribute to segment on.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-dimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-dimension-syntax.json"></a>

```
{
  "[CalculatedAttributes](#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes)" : {Key: Value, ...},
  "[ProfileAttributes](#cfn-customerprofiles-segmentdefinition-dimension-profileattributes)" : ProfileAttributes
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-dimension-syntax.yaml"></a>

```
  [CalculatedAttributes](#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes): 
    Key: Value
  [ProfileAttributes](#cfn-customerprofiles-segmentdefinition-dimension-profileattributes): 
    ProfileAttributes
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-dimension-properties"></a>

`CalculatedAttributes`  <a name="cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes"></a>
Object that holds the calculated attributes to segment on.  
*Required*: No  
*Type*: Object of [CalculatedAttributeDimension](aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ProfileAttributes`  <a name="cfn-customerprofiles-segmentdefinition-dimension-profileattributes"></a>
Object that holds the profile attributes to segment on.  
*Required*: No  
*Type*: [ProfileAttributes](aws-properties-customerprofiles-segmentdefinition-profileattributes.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition ExtraLengthValueProfileDimension
<a name="aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension"></a>

Object that segments on various Customer profile's fields that are larger than normal.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-syntax.json"></a>

```
{
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-syntax.yaml"></a>

```
  [DimensionType](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-properties"></a>

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype"></a>
The action to segment with.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values"></a>
The values to apply the DimensionType on.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `1000 | 50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition Group
<a name="aws-properties-customerprofiles-segmentdefinition-group"></a>

Contains dimensions that determine what to segment on.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-group-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-group-syntax.json"></a>

```
{
  "[Dimensions](#cfn-customerprofiles-segmentdefinition-group-dimensions)" : [ Dimension, ... ],
  "[SourceSegments](#cfn-customerprofiles-segmentdefinition-group-sourcesegments)" : [ SourceSegment, ... ],
  "[SourceType](#cfn-customerprofiles-segmentdefinition-group-sourcetype)" : String,
  "[Type](#cfn-customerprofiles-segmentdefinition-group-type)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-group-syntax.yaml"></a>

```
  [Dimensions](#cfn-customerprofiles-segmentdefinition-group-dimensions): 
    - Dimension
  [SourceSegments](#cfn-customerprofiles-segmentdefinition-group-sourcesegments): 
    - SourceSegment
  [SourceType](#cfn-customerprofiles-segmentdefinition-group-sourcetype): String
  [Type](#cfn-customerprofiles-segmentdefinition-group-type): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-group-properties"></a>

`Dimensions`  <a name="cfn-customerprofiles-segmentdefinition-group-dimensions"></a>
Defines the attributes to segment on.  
*Required*: No  
*Type*: Array of [Dimension](aws-properties-customerprofiles-segmentdefinition-dimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceSegments`  <a name="cfn-customerprofiles-segmentdefinition-group-sourcesegments"></a>
Defines the starting source of data.  
*Required*: No  
*Type*: Array of [SourceSegment](aws-properties-customerprofiles-segmentdefinition-sourcesegment.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceType`  <a name="cfn-customerprofiles-segmentdefinition-group-sourcetype"></a>
Defines how to interact with the source data.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALL | ANY | NONE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-customerprofiles-segmentdefinition-group-type"></a>
Defines how to interact with the profiles found in the current filtering.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALL | ANY | NONE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition ProfileAttributes
<a name="aws-properties-customerprofiles-segmentdefinition-profileattributes"></a>

The object used to segment on attributes within the customer profile.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-profileattributes-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-profileattributes-syntax.json"></a>

```
{
  "[AccountNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber)" : ProfileDimension,
  "[AdditionalInformation](#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation)" : ExtraLengthValueProfileDimension,
  "[Address](#cfn-customerprofiles-segmentdefinition-profileattributes-address)" : AddressDimension,
  "[Attributes](#cfn-customerprofiles-segmentdefinition-profileattributes-attributes)" : {Key: Value, ...},
  "[BillingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress)" : AddressDimension,
  "[BirthDate](#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate)" : DateDimension,
  "[BusinessEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress)" : ProfileDimension,
  "[BusinessName](#cfn-customerprofiles-segmentdefinition-profileattributes-businessname)" : ProfileDimension,
  "[BusinessPhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber)" : ProfileDimension,
  "[EmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress)" : ProfileDimension,
  "[FirstName](#cfn-customerprofiles-segmentdefinition-profileattributes-firstname)" : ProfileDimension,
  "[GenderString](#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring)" : ProfileDimension,
  "[HomePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber)" : ProfileDimension,
  "[LastName](#cfn-customerprofiles-segmentdefinition-profileattributes-lastname)" : ProfileDimension,
  "[MailingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress)" : AddressDimension,
  "[MiddleName](#cfn-customerprofiles-segmentdefinition-profileattributes-middlename)" : ProfileDimension,
  "[MobilePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber)" : ProfileDimension,
  "[PartyTypeString](#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring)" : ProfileDimension,
  "[PersonalEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress)" : ProfileDimension,
  "[PhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber)" : ProfileDimension,
  "[ProfileType](#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype)" : ProfileTypeDimension,
  "[ShippingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress)" : AddressDimension
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-profileattributes-syntax.yaml"></a>

```
  [AccountNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber): 
    ProfileDimension
  [AdditionalInformation](#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation): 
    ExtraLengthValueProfileDimension
  [Address](#cfn-customerprofiles-segmentdefinition-profileattributes-address): 
    AddressDimension
  [Attributes](#cfn-customerprofiles-segmentdefinition-profileattributes-attributes): 
    Key: Value
  [BillingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress): 
    AddressDimension
  [BirthDate](#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate): 
    DateDimension
  [BusinessEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress): 
    ProfileDimension
  [BusinessName](#cfn-customerprofiles-segmentdefinition-profileattributes-businessname): 
    ProfileDimension
  [BusinessPhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber): 
    ProfileDimension
  [EmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress): 
    ProfileDimension
  [FirstName](#cfn-customerprofiles-segmentdefinition-profileattributes-firstname): 
    ProfileDimension
  [GenderString](#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring): 
    ProfileDimension
  [HomePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber): 
    ProfileDimension
  [LastName](#cfn-customerprofiles-segmentdefinition-profileattributes-lastname): 
    ProfileDimension
  [MailingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress): 
    AddressDimension
  [MiddleName](#cfn-customerprofiles-segmentdefinition-profileattributes-middlename): 
    ProfileDimension
  [MobilePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber): 
    ProfileDimension
  [PartyTypeString](#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring): 
    ProfileDimension
  [PersonalEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress): 
    ProfileDimension
  [PhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber): 
    ProfileDimension
  [ProfileType](#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype): 
    ProfileTypeDimension
  [ShippingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress): 
    AddressDimension
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-profileattributes-properties"></a>

`AccountNumber`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber"></a>
A field to describe values to segment on within account number.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AdditionalInformation`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation"></a>
A field to describe values to segment on within additional information.  
*Required*: No  
*Type*: [ExtraLengthValueProfileDimension](aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Address`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-address"></a>
A field to describe values to segment on within address.  
*Required*: No  
*Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Attributes`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-attributes"></a>
A field to describe values to segment on within attributes.  
*Required*: No  
*Type*: Object of [AttributeDimension](aws-properties-customerprofiles-segmentdefinition-attributedimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BillingAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress"></a>
A field to describe values to segment on within billing address.  
*Required*: No  
*Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BirthDate`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-birthdate"></a>
A field to describe values to segment on within birthDate.  
*Required*: No  
*Type*: [DateDimension](aws-properties-customerprofiles-segmentdefinition-datedimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BusinessEmailAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress"></a>
A field to describe values to segment on within business email address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BusinessName`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-businessname"></a>
A field to describe values to segment on within business name.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BusinessPhoneNumber`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber"></a>
A field to describe values to segment on within business phone number.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EmailAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress"></a>
A field to describe values to segment on within email address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FirstName`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-firstname"></a>
A field to describe values to segment on within first name.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GenderString`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-genderstring"></a>
A field to describe values to segment on within genderString.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`HomePhoneNumber`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber"></a>
A field to describe values to segment on within home phone number.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LastName`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-lastname"></a>
A field to describe values to segment on within last name.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MailingAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress"></a>
A field to describe values to segment on within mailing address.  
*Required*: No  
*Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MiddleName`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-middlename"></a>
A field to describe values to segment on within middle name.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MobilePhoneNumber`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber"></a>
A field to describe values to segment on within mobile phone number.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PartyTypeString`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring"></a>
A field to describe values to segment on within partyTypeString.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PersonalEmailAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress"></a>
A field to describe values to segment on within personal email address.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PhoneNumber`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber"></a>
A field to describe values to segment on within phone number.  
*Required*: No  
*Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ProfileType`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-profiletype"></a>
The type of profile.  
*Required*: No  
*Type*: [ProfileTypeDimension](aws-properties-customerprofiles-segmentdefinition-profiletypedimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ShippingAddress`  <a name="cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress"></a>
A field to describe values to segment on within shipping address.  
*Required*: No  
*Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition ProfileDimension
<a name="aws-properties-customerprofiles-segmentdefinition-profiledimension"></a>

Object that segments on various Customer profile's fields that are larger than normal.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-profiledimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-profiledimension-syntax.json"></a>

```
{
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-profiledimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-profiledimension-syntax.yaml"></a>

```
  [DimensionType](#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-profiledimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-profiledimension-properties"></a>

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype"></a>
The action to segment on.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-profiledimension-values"></a>
Property description not available.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `255 | 50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition ProfileTypeDimension
<a name="aws-properties-customerprofiles-segmentdefinition-profiletypedimension"></a>

Specifies profile type based criteria for a segment.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-profiletypedimension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-profiletypedimension-syntax.json"></a>

```
{
  "[DimensionType](#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype)" : String,
  "[Values](#cfn-customerprofiles-segmentdefinition-profiletypedimension-values)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-profiletypedimension-syntax.yaml"></a>

```
  [DimensionType](#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype): String
  [Values](#cfn-customerprofiles-segmentdefinition-profiletypedimension-values): 
    - String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-profiletypedimension-properties"></a>

`DimensionType`  <a name="cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype"></a>
The action to segment on.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `INCLUSIVE | EXCLUSIVE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Values`  <a name="cfn-customerprofiles-segmentdefinition-profiletypedimension-values"></a>
The values to apply the DimensionType on.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition RangeOverride
<a name="aws-properties-customerprofiles-segmentdefinition-rangeoverride"></a>

Overrides the original range on a calculated attribute definition.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-rangeoverride-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-rangeoverride-syntax.json"></a>

```
{
  "[End](#cfn-customerprofiles-segmentdefinition-rangeoverride-end)" : Integer,
  "[Start](#cfn-customerprofiles-segmentdefinition-rangeoverride-start)" : Integer,
  "[Unit](#cfn-customerprofiles-segmentdefinition-rangeoverride-unit)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-rangeoverride-syntax.yaml"></a>

```
  [End](#cfn-customerprofiles-segmentdefinition-rangeoverride-end): Integer
  [Start](#cfn-customerprofiles-segmentdefinition-rangeoverride-start): Integer
  [Unit](#cfn-customerprofiles-segmentdefinition-rangeoverride-unit): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-rangeoverride-properties"></a>

`End`  <a name="cfn-customerprofiles-segmentdefinition-rangeoverride-end"></a>
The end time of when to include objects.  
*Required*: No  
*Type*: Integer  
*Minimum*: `-2147483648`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Start`  <a name="cfn-customerprofiles-segmentdefinition-rangeoverride-start"></a>
The start time of when to include objects.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `-2147483648`  
*Maximum*: `2147483647`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Unit`  <a name="cfn-customerprofiles-segmentdefinition-rangeoverride-unit"></a>
The unit for start and end.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DAYS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition SegmentGroup
<a name="aws-properties-customerprofiles-segmentdefinition-segmentgroup"></a>

Contains all groups of the segment definition.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-segmentgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-segmentgroup-syntax.json"></a>

```
{
  "[Groups](#cfn-customerprofiles-segmentdefinition-segmentgroup-groups)" : [ Group, ... ],
  "[Include](#cfn-customerprofiles-segmentdefinition-segmentgroup-include)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-segmentgroup-syntax.yaml"></a>

```
  [Groups](#cfn-customerprofiles-segmentdefinition-segmentgroup-groups): 
    - Group
  [Include](#cfn-customerprofiles-segmentdefinition-segmentgroup-include): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-segmentgroup-properties"></a>

`Groups`  <a name="cfn-customerprofiles-segmentdefinition-segmentgroup-groups"></a>
Holds the list of groups within the segment definition.  
*Required*: No  
*Type*: Array of [Group](aws-properties-customerprofiles-segmentdefinition-group.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Include`  <a name="cfn-customerprofiles-segmentdefinition-segmentgroup-include"></a>
Defines whether to include or exclude the profiles that fit the segment criteria.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALL | ANY | NONE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition SegmentSort
<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort"></a>

<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort-description"></a>The `SegmentSort` property type specifies Property description not available. for an [AWS::CustomerProfiles::SegmentDefinition](aws-resource-customerprofiles-segmentdefinition.md).

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort-syntax.json"></a>

```
{
  "[Attributes](#cfn-customerprofiles-segmentdefinition-segmentsort-attributes)" : [ SortAttribute, ... ]
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort-syntax.yaml"></a>

```
  [Attributes](#cfn-customerprofiles-segmentdefinition-segmentsort-attributes): 
    - SortAttribute
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-segmentsort-properties"></a>

`Attributes`  <a name="cfn-customerprofiles-segmentdefinition-segmentsort-attributes"></a>
Property description not available.  
*Required*: Yes  
*Type*: Array of [SortAttribute](aws-properties-customerprofiles-segmentdefinition-sortattribute.md)  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CustomerProfiles::SegmentDefinition SortAttribute
<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute"></a>

<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute-description"></a>The `SortAttribute` property type specifies Property description not available. for an [AWS::CustomerProfiles::SegmentDefinition](aws-resource-customerprofiles-segmentdefinition.md).

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute-syntax.json"></a>

```
{
  "[DataType](#cfn-customerprofiles-segmentdefinition-sortattribute-datatype)" : String,
  "[Name](#cfn-customerprofiles-segmentdefinition-sortattribute-name)" : String,
  "[Order](#cfn-customerprofiles-segmentdefinition-sortattribute-order)" : String,
  "[Type](#cfn-customerprofiles-segmentdefinition-sortattribute-type)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute-syntax.yaml"></a>

```
  [DataType](#cfn-customerprofiles-segmentdefinition-sortattribute-datatype): String
  [Name](#cfn-customerprofiles-segmentdefinition-sortattribute-name): String
  [Order](#cfn-customerprofiles-segmentdefinition-sortattribute-order): String
  [Type](#cfn-customerprofiles-segmentdefinition-sortattribute-type): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-sortattribute-properties"></a>

`DataType`  <a name="cfn-customerprofiles-segmentdefinition-sortattribute-datatype"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `STRING | NUMBER | DATE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-customerprofiles-segmentdefinition-sortattribute-name"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Order`  <a name="cfn-customerprofiles-segmentdefinition-sortattribute-order"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ASC | DESC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-customerprofiles-segmentdefinition-sortattribute-type"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `PROFILE | CALCULATED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CustomerProfiles::SegmentDefinition SourceSegment
<a name="aws-properties-customerprofiles-segmentdefinition-sourcesegment"></a>

The source segments to build off of.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-sourcesegment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-sourcesegment-syntax.json"></a>

```
{
  "[SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-sourcesegment-syntax.yaml"></a>

```
  [SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-sourcesegment-properties"></a>

`SegmentDefinitionName`  <a name="cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname"></a>
The name of the source segment.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::CustomerProfiles::SegmentDefinition Tag
<a name="aws-properties-customerprofiles-segmentdefinition-tag"></a>

The tag belonging to the segment definition.

## Syntax
<a name="aws-properties-customerprofiles-segmentdefinition-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-customerprofiles-segmentdefinition-tag-syntax.json"></a>

```
{
  "[Key](#cfn-customerprofiles-segmentdefinition-tag-key)" : String,
  "[Value](#cfn-customerprofiles-segmentdefinition-tag-value)" : String
}
```

### YAML
<a name="aws-properties-customerprofiles-segmentdefinition-tag-syntax.yaml"></a>

```
  [Key](#cfn-customerprofiles-segmentdefinition-tag-key): String
  [Value](#cfn-customerprofiles-segmentdefinition-tag-value): String
```

## Properties
<a name="aws-properties-customerprofiles-segmentdefinition-tag-properties"></a>

`Key`  <a name="cfn-customerprofiles-segmentdefinition-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-customerprofiles-segmentdefinition-tag-value"></a>
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)