software.amazon.awscdk.services.pinpoint

Interface CfnSegmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSegmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.750Z")
 @Stability(value=Stable)
public interface CfnSegmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Pinpoint::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 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 Classes

Modifier and Type	Interface and Description
static class	CfnSegmentProps.Builder A builder for CfnSegmentProps
static class	CfnSegmentProps.Jsii$Proxy An implementation for CfnSegmentProps

Method Summary

Modifier and Type	Method and Description
static CfnSegmentProps.Builder	builder()
String	getApplicationId() `AWS::Pinpoint::Segment.ApplicationId`.
default Object	getDimensions() `AWS::Pinpoint::Segment.Dimensions`.
String	getName() `AWS::Pinpoint::Segment.Name`.
default Object	getSegmentGroups() `AWS::Pinpoint::Segment.SegmentGroups`.
default Object	getTags() `AWS::Pinpoint::Segment.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApplicationId

@Stability(value=Stable)
 @NotNull
String getApplicationId()

`AWS::Pinpoint::Segment.ApplicationId`.

getDimensions

@Stability(value=Stable)
 @Nullable
default Object getDimensions()

`AWS::Pinpoint::Segment.Dimensions`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Pinpoint::Segment.Name`.

getSegmentGroups

@Stability(value=Stable)
 @Nullable
default Object getSegmentGroups()

`AWS::Pinpoint::Segment.SegmentGroups`.

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

`AWS::Pinpoint::Segment.Tags`.

builder

@Stability(value=Stable)
static CfnSegmentProps.Builder builder()

Returns:

a CfnSegmentProps.Builder of CfnSegmentProps