Interface CfnSegment.SegmentGroupsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSegment.SegmentGroupsProperty.Jsii$Proxy
Enclosing class:
CfnSegment

@Stability(Stable) public static interface CfnSegment.SegmentGroupsProperty extends software.amazon.jsii.JsiiSerializable
Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

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.pinpoint.*;
 Object attributes;
 Object metrics;
 Object userAttributes;
 SegmentGroupsProperty segmentGroupsProperty = SegmentGroupsProperty.builder()
         .groups(List.of(GroupsProperty.builder()
                 .dimensions(List.of(SegmentDimensionsProperty.builder()
                         .attributes(attributes)
                         .behavior(BehaviorProperty.builder()
                                 .recency(RecencyProperty.builder()
                                         .duration("duration")
                                         .recencyType("recencyType")
                                         .build())
                                 .build())
                         .demographic(DemographicProperty.builder()
                                 .appVersion(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .channel(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .deviceType(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .make(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .model(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .platform(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .build())
                         .location(LocationProperty.builder()
                                 .country(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .gpsPoint(GPSPointProperty.builder()
                                         .coordinates(CoordinatesProperty.builder()
                                                 .latitude(123)
                                                 .longitude(123)
                                                 .build())
                                         .rangeInKilometers(123)
                                         .build())
                                 .build())
                         .metrics(metrics)
                         .userAttributes(userAttributes)
                         .build()))
                 .sourceSegments(List.of(SourceSegmentsProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .version(123)
                         .build()))
                 .sourceType("sourceType")
                 .type("type")
                 .build()))
         .include("include")
         .build();
 
  • Method Details

    • getGroups

      @Stability(Stable) @Nullable default Object getGroups()
      Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
    • getInclude

      @Stability(Stable) @Nullable default String getInclude()
      Specifies how to handle multiple segment groups for the segment.

      For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

    • builder

      @Stability(Stable) static CfnSegment.SegmentGroupsProperty.Builder builder()
      Returns:
      a CfnSegment.SegmentGroupsProperty.Builder of CfnSegment.SegmentGroupsProperty