All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnSegmentDefinitionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.768Z") @Stability(Stable) public interface CfnSegmentDefinitionMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnSegmentDefinitionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.customerprofiles.*;
 CfnSegmentDefinitionMixinProps cfnSegmentDefinitionMixinProps = CfnSegmentDefinitionMixinProps.builder()
         .description("description")
         .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()
                                                 .conditionOverrides(ConditionOverridesProperty.builder()
                                                         .range(RangeOverrideProperty.builder()
                                                                 .end(123)
                                                                 .start(123)
                                                                 .unit("unit")
                                                                 .build())
                                                         .build())
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnSegmentDefinitionMixinProps.Builder

A builder for CfnSegmentDefinitionMixinProps

static final class

CfnSegmentDefinitionMixinProps.Jsii$Proxy

An implementation for CfnSegmentDefinitionMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnSegmentDefinitionMixinProps.Builder

builder()

default String

getDescription()

The description of the segment definition.

default String

getDisplayName()

Display name of the segment definition.

default String

getDomainName()

The name of the domain.

default String

getSegmentDefinitionName()

Name of the segment definition.

default Object

getSegmentGroups()

Contains all groups of the segment definition.

default String

getSegmentSqlQuery()

The SQL query that defines the segment criteria.

default List<CfnTag>

getTags()

The tags belonging to the segment definition.

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

Method Details
- 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
- getDisplayName
  
  @Stability(Stable) @Nullable default 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) @Nullable default 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) @Nullable default 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) @Nullable default Object getSegmentGroups()
  
  Contains all groups of the segment definition.
  Returns union: either IResolvable or CfnSegmentDefinitionPropsMixin.SegmentGroupProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentgroups
- getSegmentSqlQuery
  
  @Stability(Stable) @Nullable default String getSegmentSqlQuery()
  
  The SQL query that defines the segment criteria.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsqlquery
- 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 CfnSegmentDefinitionMixinProps.Builder builder()
  
  Returns:
  
  a CfnSegmentDefinitionMixinProps.Builder of CfnSegmentDefinitionMixinProps

Interface CfnSegmentDefinitionMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDescription

getDisplayName

getDomainName

getSegmentDefinitionName

getSegmentGroups

getSegmentSqlQuery

getTags

builder