Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnSegmentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnSegmentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.324Z")
@Stability(Stable)
public class CfnSegmentPropsMixin
extends Mixin
implements software.constructs.IMixin

Updates the configuration, dimension, and other settings for an existing 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.cfnpropertymixins.services.pinpoint.*;
 import software.amazon.awscdk.*;
 Object attributes;
 IMergeStrategy mergeStrategy;
 Object metrics;
 Object tags;
 Object userAttributes;
 CfnSegmentPropsMixin cfnSegmentPropsMixin = CfnSegmentPropsMixin.Builder.create(CfnSegmentMixinProps.builder()
         .applicationId("applicationId")
         .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())
         .name("name")
         .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")
                                 .version(123)
                                 .build()))
                         .sourceType("sourceType")
                         .type("type")
                         .build()))
                 .include("include")
                 .build())
         .tags(tags)
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnSegmentPropsMixin.BehaviorProperty	Specifies behavior-based criteria for the segment, such as how recently users have used your app.
static final class	CfnSegmentPropsMixin.Builder	A fluent builder for CfnSegmentPropsMixin.
static interface	CfnSegmentPropsMixin.CoordinatesProperty	Specifies the GPS coordinates of a location.
static interface	CfnSegmentPropsMixin.DemographicProperty	Specifies demographic-based criteria, such as device platform, for the segment.
static interface	CfnSegmentPropsMixin.GPSPointProperty	Specifies the GPS coordinates of the endpoint location.
static interface	CfnSegmentPropsMixin.GroupsProperty	An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
static interface	CfnSegmentPropsMixin.LocationProperty	Specifies location-based criteria, such as region or GPS coordinates, for the segment.
static interface	CfnSegmentPropsMixin.RecencyProperty	Specifies how recently segment members were active.
static interface	CfnSegmentPropsMixin.SegmentDimensionsProperty	Specifies the dimension settings for a segment.
static interface	CfnSegmentPropsMixin.SegmentGroupsProperty	Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
static interface	CfnSegmentPropsMixin.SetDimensionProperty	Specifies the dimension type and values for a segment dimension.
static interface	CfnSegmentPropsMixin.SourceSegmentsProperty	Specifies the base segment to build the segment on.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnSegmentPropsMixin(CfnSegmentMixinProps props)	Create a mixin to apply properties to AWS::Pinpoint::Segment.
	CfnSegmentPropsMixin(CfnSegmentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Pinpoint::Segment.
protected	CfnSegmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSegmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnSegmentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnSegmentPropsMixin

protected CfnSegmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnSegmentPropsMixin

protected CfnSegmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSegmentPropsMixin

@Stability(Stable)
public CfnSegmentPropsMixin(@NotNull
 CfnSegmentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Pinpoint::Segment.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnSegmentPropsMixin

@Stability(Stable)
public CfnSegmentPropsMixin(@NotNull
 CfnSegmentMixinProps props)

Create a mixin to apply properties to AWS::Pinpoint::Segment.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnSegmentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()