All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnSegmentDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:02.042Z") @Stability(Stable) public interface CfnSegmentDefinitionProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSegmentDefinition.

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.*;
 CfnSegmentDefinitionProps cfnSegmentDefinitionProps = CfnSegmentDefinitionProps.builder()
         .displayName("displayName")
         .domainName("domainName")
         .segmentDefinitionName("segmentDefinitionName")
         .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())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnSegmentDefinitionProps.Builder

A builder for CfnSegmentDefinitionProps

static final class

CfnSegmentDefinitionProps.Jsii$Proxy

An implementation for CfnSegmentDefinitionProps
Method Summary

Modifier and Type

Method

Description

static CfnSegmentDefinitionProps.Builder

builder()

default 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.

Object

getSegmentGroups()

Contains all groups of the segment definition.

default List<CfnTag>

getTags()

The tags belonging to the segment definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getDisplayName
  
  @Stability(Stable) @NotNull String getDisplayName()
  
  Display name of the segment definition.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-displayname
- getDomainName
  
  @Stability(Stable) @NotNull String getDomainName()
  
  The name of the domain.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-domainname
- getSegmentDefinitionName
  
  @Stability(Stable) @NotNull String getSegmentDefinitionName()
  
  Name of the segment definition.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionname
- getSegmentGroups
  
  @Stability(Stable) @NotNull Object getSegmentGroups()
  
  Contains all groups of the segment definition.
  Returns union: either IResolvable or CfnSegmentDefinition.SegmentGroupProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentgroups
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description of the segment definition.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-description
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  The tags belonging to the segment definition.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-tags
- builder
  
  @Stability(Stable) static CfnSegmentDefinitionProps.Builder builder()
  
  Returns:
  
  a CfnSegmentDefinitionProps.Builder of CfnSegmentDefinitionProps

Interface CfnSegmentDefinitionProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDisplayName

getDomainName

getSegmentDefinitionName

getSegmentGroups

getDescription

getTags

builder