Package software.amazon.awscdk.services.customerprofiles

Class CfnSegmentDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.customerprofiles.CfnSegmentDefinition

All Implemented Interfaces:

IInspectable, ISegmentDefinitionRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:10.656Z")
@Stability(Stable)
public class CfnSegmentDefinition
extends CfnResource
implements IInspectable, ISegmentDefinitionRef, ITaggableV2

A segment definition resource of Amazon Connect Customer Profiles.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.customerprofiles.*;
 CfnSegmentDefinition cfnSegmentDefinition = CfnSegmentDefinition.Builder.create(this, "MyCfnSegmentDefinition")
         .displayName("displayName")
         .domainName("domainName")
         .segmentDefinitionName("segmentDefinitionName")
         // the properties below are optional
         .description("description")
         .segmentGroups(SegmentGroupProperty.builder()
                 .groups(List.of(GroupProperty.builder()
                         .dimensions(List.of(DimensionProperty.builder()
                                 .calculatedAttributes(Map.of(
                                         "calculatedAttributesKey", CalculatedAttributeDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 // the properties below are optional
                                                 .conditionOverrides(ConditionOverridesProperty.builder()
                                                         .range(RangeOverrideProperty.builder()
                                                                 .start(123)
                                                                 .unit("unit")
                                                                 // the properties below are optional
                                                                 .end(123)
                                                                 .build())
                                                         .build())
                                                 .build()))
                                 .profileAttributes(ProfileAttributesProperty.builder()
                                         .accountNumber(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .additionalInformation(ExtraLengthValueProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .address(AddressDimensionProperty.builder()
                                                 .city(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .country(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .county(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .postalCode(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .province(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .state(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .build())
                                         .attributes(Map.of(
                                                 "attributesKey", AttributeDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build()))
                                         .billingAddress(AddressDimensionProperty.builder()
                                                 .city(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .country(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .county(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .postalCode(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .province(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .state(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .build())
                                         .birthDate(DateDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .businessEmailAddress(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .businessName(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .businessPhoneNumber(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .emailAddress(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .firstName(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .genderString(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .homePhoneNumber(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .lastName(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .mailingAddress(AddressDimensionProperty.builder()
                                                 .city(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .country(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .county(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .postalCode(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .province(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .state(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .build())
                                         .middleName(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .mobilePhoneNumber(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .partyTypeString(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .personalEmailAddress(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .phoneNumber(ProfileDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .profileType(ProfileTypeDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .shippingAddress(AddressDimensionProperty.builder()
                                                 .city(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .country(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .county(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .postalCode(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .province(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .state(ProfileDimensionProperty.builder()
                                                         .dimensionType("dimensionType")
                                                         .values(List.of("values"))
                                                         .build())
                                                 .build())
                                         .build())
                                 .build()))
                         .sourceSegments(List.of(SourceSegmentProperty.builder()
                                 .segmentDefinitionName("segmentDefinitionName")
                                 .build()))
                         .sourceType("sourceType")
                         .type("type")
                         .build()))
                 .include("include")
                 .build())
         .segmentSqlQuery("segmentSqlQuery")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnSegmentDefinition.AddressDimensionProperty	Object that segments on Customer Profile's address object.
static interface	CfnSegmentDefinition.AttributeDimensionProperty	Object that defines how to filter the incoming objects for the calculated attribute.
static final class	CfnSegmentDefinition.Builder	A fluent builder for CfnSegmentDefinition.
static interface	CfnSegmentDefinition.CalculatedAttributeDimensionProperty	Object that segments on Customer Profile's Calculated Attributes.
static interface	CfnSegmentDefinition.ConditionOverridesProperty	An object to override the original condition block of a calculated attribute.
static interface	CfnSegmentDefinition.DateDimensionProperty	Object that segments on various Customer Profile's date fields.
static interface	CfnSegmentDefinition.DimensionProperty	Defines the attribute to segment on.
static interface	CfnSegmentDefinition.ExtraLengthValueProfileDimensionProperty	Object that segments on various Customer profile's fields that are larger than normal.
static interface	CfnSegmentDefinition.GroupProperty	Contains dimensions that determine what to segment on.
static interface	CfnSegmentDefinition.ProfileAttributesProperty	The object used to segment on attributes within the customer profile.
static interface	CfnSegmentDefinition.ProfileDimensionProperty	Object that segments on various Customer profile's fields that are larger than normal.
static interface	CfnSegmentDefinition.ProfileTypeDimensionProperty	Specifies profile type based criteria for a segment.
static interface	CfnSegmentDefinition.RangeOverrideProperty	Overrides the original range on a calculated attribute definition.
static interface	CfnSegmentDefinition.SegmentGroupProperty	Contains all groups of the segment definition.
static interface	CfnSegmentDefinition.SourceSegmentProperty	The source segments to build off of.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.customerprofiles.ISegmentDefinitionRef

ISegmentDefinitionRef.Jsii$Default, ISegmentDefinitionRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSegmentDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSegmentDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSegmentDefinition(software.constructs.Construct scope, String id, CfnSegmentDefinitionProps props)	Create a new AWS::CustomerProfiles::SegmentDefinition.

Method Summary

Modifier and Type	Method	Description
static String	arnForSegmentDefinition(ISegmentDefinitionRef resource)
String	getAttrCreatedAt()	When the segment definition was created.
String	getAttrSegmentDefinitionArn()	The arn of the segment definition.
String	getAttrSegmentType()	The SQL query that defines the segment criteria.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the segment definition.
String	getDisplayName()	Display name of the segment definition.
String	getDomainName()	The name of the domain.
String	getSegmentDefinitionName()	Name of the segment definition.
SegmentDefinitionReference	getSegmentDefinitionRef()	A reference to a SegmentDefinition resource.
Object	getSegmentGroups()	Contains all groups of the segment definition.
String	getSegmentSqlQuery()	The SQL query that defines the segment criteria.
List<CfnTag>	getTags()	The tags belonging to the segment definition.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnSegmentDefinition(Object x)	Checks whether the given object is a CfnSegmentDefinition.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the segment definition.
void	setDisplayName(String value)	Display name of the segment definition.
void	setDomainName(String value)	The name of the domain.
void	setSegmentDefinitionName(String value)	Name of the segment definition.
void	setSegmentGroups(IResolvable value)	Contains all groups of the segment definition.
void	setSegmentGroups(CfnSegmentDefinition.SegmentGroupProperty value)	Contains all groups of the segment definition.
void	setSegmentSqlQuery(String value)	The SQL query that defines the segment criteria.
void	setTags(List<CfnTag> value)	The tags belonging to the segment definition.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSegmentDefinition

protected CfnSegmentDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnSegmentDefinition

protected CfnSegmentDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSegmentDefinition

@Stability(Stable)
public CfnSegmentDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSegmentDefinitionProps props)

Create a new AWS::CustomerProfiles::SegmentDefinition.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForSegmentDefinition

@Stability(Stable)
@NotNull
public static String arnForSegmentDefinition(@NotNull
 ISegmentDefinitionRef resource)

Parameters:

resource - This parameter is required.

isCfnSegmentDefinition

@Stability(Stable)
@NotNull
public static Boolean isCfnSegmentDefinition(@NotNull
 Object x)

Checks whether the given object is a CfnSegmentDefinition.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

When the segment definition was created.

getAttrSegmentDefinitionArn

@Stability(Stable)
@NotNull
public String getAttrSegmentDefinitionArn()

The arn of the segment definition.

getAttrSegmentType

@Stability(Stable)
@NotNull
public String getAttrSegmentType()

The SQL query that defines the segment criteria.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSegmentDefinitionRef

@Stability(Stable)
@NotNull
public SegmentDefinitionReference getSegmentDefinitionRef()

A reference to a SegmentDefinition resource.

Specified by:

getSegmentDefinitionRef in interface ISegmentDefinitionRef

getDisplayName

@Stability(Stable)
@NotNull
public String getDisplayName()

Display name of the segment definition.

setDisplayName

@Stability(Stable)
public void setDisplayName(@NotNull
 String value)

Display name of the segment definition.

getDomainName

@Stability(Stable)
@NotNull
public String getDomainName()

The name of the domain.

setDomainName

@Stability(Stable)
public void setDomainName(@NotNull
 String value)

The name of the domain.

getSegmentDefinitionName

@Stability(Stable)
@NotNull
public String getSegmentDefinitionName()

Name of the segment definition.

setSegmentDefinitionName

@Stability(Stable)
public void setSegmentDefinitionName(@NotNull
 String value)

Name of the segment definition.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the segment definition.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the segment definition.

getSegmentGroups

@Stability(Stable)
@Nullable
public Object getSegmentGroups()

Contains all groups of the segment definition.

Returns union: either IResolvable or CfnSegmentDefinition.SegmentGroupProperty

setSegmentGroups

@Stability(Stable)
public void setSegmentGroups(@Nullable
 IResolvable value)

Contains all groups of the segment definition.

setSegmentGroups

@Stability(Stable)
public void setSegmentGroups(@Nullable
 CfnSegmentDefinition.SegmentGroupProperty value)

Contains all groups of the segment definition.

getSegmentSqlQuery

@Stability(Stable)
@Nullable
public String getSegmentSqlQuery()

The SQL query that defines the segment criteria.

setSegmentSqlQuery

@Stability(Stable)
public void setSegmentSqlQuery(@Nullable
 String value)

The SQL query that defines the segment criteria.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

The tags belonging to the segment definition.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags belonging to the segment definition.