Package software.amazon.awscdk.services.pinpoint

Interface CfnSegment.GroupsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSegment.GroupsProperty.Jsii$Proxy
Enclosing class:
CfnSegment
@Stability(Stable) public static interface CfnSegment.GroupsProperty extends software.amazon.jsii.JsiiSerializable
An array that defines 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;
 GroupsProperty groupsProperty = 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();

  • Method Details

    • getDimensions

      @Stability(Stable) @Nullable default Object getDimensions()
      An array that defines the dimensions to include or exclude from the segment.

    • getSourceSegments

      @Stability(Stable) @Nullable default Object getSourceSegments()
      The base segment to build the segment on.

      A base segment, also called a source segment , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

      You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.

    • getSourceType

      @Stability(Stable) @Nullable default String getSourceType()
      Specifies how to handle multiple base segments for the segment.

      For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

    • getType

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

      For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

    • builder

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