Interface CfnSegmentProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSegmentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:00.883Z")
@Stability(Stable)
public interface CfnSegmentProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnSegment
.
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 tags; Object userAttributes; CfnSegmentProps cfnSegmentProps = CfnSegmentProps.builder() .applicationId("applicationId") .name("name") // the properties below are optional .dimensions(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()) .segmentGroups(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()) .tags(tags) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnSegmentProps
static final class
An implementation forCfnSegmentProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnSegmentProps.Builder
builder()
The unique identifier for the Amazon Pinpoint application that the segment is associated with.default Object
The criteria that define the dimensions for the segment.getName()
The name of the segment.default Object
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.default Object
getTags()
An array of key-value pairs to apply to this resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The unique identifier for the Amazon Pinpoint application that the segment is associated with. -
getName
The name of the segment.A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
-
getDimensions
The criteria that define the dimensions for the segment. -
getSegmentGroups
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.A segment group can consist of zero or more base segments. Your request can include only one segment group.
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
-
builder
- Returns:
- a
CfnSegmentProps.Builder
ofCfnSegmentProps
-