Package software.amazon.awscdk.services.pinpoint

Interface CfnSegment.SegmentDimensionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSegment.SegmentDimensionsProperty.Jsii$Proxy

Enclosing class:

CfnSegment

@Stability(Stable)
public static interface CfnSegment.SegmentDimensionsProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the dimension settings for a 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;
 SegmentDimensionsProperty segmentDimensionsProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSegment.SegmentDimensionsProperty.Builder	builder()
default Object	getAttributes()	One or more custom attributes to use as criteria for the segment.
default Object	getBehavior()	The behavior-based criteria, such as how recently users have used your app, for the segment.
default Object	getDemographic()	The demographic-based criteria, such as device platform, for the segment.
default Object	getLocation()	The location-based criteria, such as region or GPS coordinates, for the segment.
default Object	getMetrics()	One or more custom metrics to use as criteria for the segment.
default Object	getUserAttributes()	One or more custom user attributes to use as criteria for the segment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributes

@Stability(Stable)
@Nullable
default Object getAttributes()

One or more custom attributes to use as criteria for the segment.

For more information see AttributeDimension

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-attributes

getBehavior

@Stability(Stable)
@Nullable
default Object getBehavior()

The behavior-based criteria, such as how recently users have used your app, for the segment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-behavior

getDemographic

@Stability(Stable)
@Nullable
default Object getDemographic()

The demographic-based criteria, such as device platform, for the segment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-demographic

getLocation

@Stability(Stable)
@Nullable
default Object getLocation()

The location-based criteria, such as region or GPS coordinates, for the segment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-location

getMetrics

@Stability(Stable)
@Nullable
default Object getMetrics()

One or more custom metrics to use as criteria for the segment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-metrics

getUserAttributes

@Stability(Stable)
@Nullable
default Object getUserAttributes()

One or more custom user attributes to use as criteria for the segment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-userattributes

builder

@Stability(Stable)
static CfnSegment.SegmentDimensionsProperty.Builder builder()

Returns:

a CfnSegment.SegmentDimensionsProperty.Builder of CfnSegment.SegmentDimensionsProperty