L1 ConstructAWS::CustomerProfiles::SegmentDefinition

CfnSegmentDefinition

A segment definition resource of Amazon Connect Customer Profiles.

Import

import { CfnSegmentDefinition } from 'aws-cdk-lib/aws-customerprofiles';

Or use the module namespace:

import * as customerprofiles from 'aws-cdk-lib/aws-customerprofiles';
// customerprofiles.CfnSegmentDefinition

Configuration passed to the constructor as CfnSegmentDefinitionProps.

displayNameRequired

string

Display name of the segment definition.

domainNameRequired

string

The name of the domain.

segmentDefinitionNameRequired

string

Name of the segment definition.

descriptionOptional

string

The description of the segment definition.

segmentGroupsOptional

IResolvable | SegmentGroupProperty

Contains all groups of the segment definition.

segmentSortOptional

IResolvable | SegmentSortProperty

Defines how segments should be sorted and ordered in the results.

segmentSqlQueryOptional

string

The SQL query that defines the segment criteria.

tagsOptional

CfnTag[]

The tags belonging to the segment definition.

This L1 construct maps directly to the following CloudFormation resource type.

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

LevelL1 (CloudFormation)

Moduleaws-customerprofiles

CFN TypeAWS::CustomerProfiles::SegmentDefinition

Properties8