Package software.amazon.awscdk.services.evidently

Interface CfnLaunch.SegmentOverrideProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunch.SegmentOverrideProperty.Jsii$Proxy

Enclosing class:

CfnLaunch

@Stability(Stable)
public static interface CfnLaunch.SegmentOverrideProperty
extends software.amazon.jsii.JsiiSerializable

Use this structure to specify different traffic splits for one or more audience segments .

A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

For more information, see Use segments to focus your audience .

This sructure is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that 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.evidently.*;
 SegmentOverrideProperty segmentOverrideProperty = SegmentOverrideProperty.builder()
         .evaluationOrder(123)
         .segment("segment")
         .weights(List.of(GroupToWeightProperty.builder()
                 .groupName("groupName")
                 .splitWeight(123)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunch.SegmentOverrideProperty.Builder	builder()
Number	getEvaluationOrder()	A number indicating the order to use to evaluate segment overrides, if there are more than one.
String	getSegment()	The ARN of the segment to use for this override.
Object	getWeights()	The traffic allocation percentages among the feature variations to assign to this segment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEvaluationOrder

@Stability(Stable)
@NotNull
Number getEvaluationOrder()

A number indicating the order to use to evaluate segment overrides, if there are more than one.

Segment overrides with lower numbers are evaluated first.

getSegment

@Stability(Stable)
@NotNull
String getSegment()

The ARN of the segment to use for this override.

getWeights

@Stability(Stable)
@NotNull
Object getWeights()

The traffic allocation percentages among the feature variations to assign to this segment.

This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

builder

@Stability(Stable)
static CfnLaunch.SegmentOverrideProperty.Builder builder()

Returns:

a CfnLaunch.SegmentOverrideProperty.Builder of CfnLaunch.SegmentOverrideProperty