Package software.amazon.awscdk.cfnpropertymixins.services.evidently

Interface CfnExperimentMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperimentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.391Z")
@Stability(Stable)
public interface CfnExperimentMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnExperimentPropsMixin.

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.evidently.*;
 CfnExperimentMixinProps cfnExperimentMixinProps = CfnExperimentMixinProps.builder()
         .description("description")
         .metricGoals(List.of(MetricGoalObjectProperty.builder()
                 .desiredChange("desiredChange")
                 .entityIdKey("entityIdKey")
                 .eventPattern("eventPattern")
                 .metricName("metricName")
                 .unitLabel("unitLabel")
                 .valueKey("valueKey")
                 .build()))
         .name("name")
         .onlineAbConfig(OnlineAbConfigObjectProperty.builder()
                 .controlTreatmentName("controlTreatmentName")
                 .treatmentWeights(List.of(TreatmentToWeightProperty.builder()
                         .splitWeight(123)
                         .treatment("treatment")
                         .build()))
                 .build())
         .project("project")
         .randomizationSalt("randomizationSalt")
         .removeSegment(false)
         .runningStatus(RunningStatusObjectProperty.builder()
                 .analysisCompleteTime("analysisCompleteTime")
                 .desiredState("desiredState")
                 .reason("reason")
                 .status("status")
                 .build())
         .samplingRate(123)
         .segment("segment")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .treatments(List.of(TreatmentObjectProperty.builder()
                 .description("description")
                 .feature("feature")
                 .treatmentName("treatmentName")
                 .variation("variation")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExperimentMixinProps.Builder	builder()
default String	getDescription()	An optional description of the experiment.
default Object	getMetricGoals()	An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
default String	getName()	A name for the new experiment.
default Object	getOnlineAbConfig()	A structure that contains the configuration of which variation to use as the "control" version.
default String	getProject()	The name or the ARN of the project where this experiment is to be created.
default String	getRandomizationSalt()	When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served.
default Object	getRemoveSegment()	Set this to true to remove the segment that is associated with this experiment.
default Object	getRunningStatus()	A structure that you can use to start and stop the experiment.
default Number	getSamplingRate()	The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
default String	getSegment()	Specifies an audience segment to use in the experiment.
default List<CfnTag>	getTags()	Assigns one or more tags (key-value pairs) to the experiment.
default Object	getTreatments()	An array of structures that describe the configuration of each feature variation used in the experiment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description of the experiment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-description

getMetricGoals

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

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

You can use up to three metrics in an experiment.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnExperimentPropsMixin.MetricGoalObjectProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-metricgoals

getName

@Stability(Stable)
@Nullable
default String getName()

A name for the new experiment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-name

getOnlineAbConfig

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

A structure that contains the configuration of which variation to use as the "control" version.

The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

Returns union: either IResolvable or CfnExperimentPropsMixin.OnlineAbConfigObjectProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-onlineabconfig

getProject

@Stability(Stable)
@Nullable
default String getProject()

The name or the ARN of the project where this experiment is to be created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-project

getRandomizationSalt

@Stability(Stable)
@Nullable
default String getRandomizationSalt()

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served.

This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-randomizationsalt

getRemoveSegment

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

Set this to true to remove the segment that is associated with this experiment.

You can't use this parameter if the experiment is currently running.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-removesegment

getRunningStatus

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

A structure that you can use to start and stop the experiment.

Returns union: either IResolvable or CfnExperimentPropsMixin.RunningStatusObjectProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-runningstatus

getSamplingRate

@Stability(Stable)
@Nullable
default Number getSamplingRate()

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.

The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-samplingrate

getSegment

@Stability(Stable)
@Nullable
default String getSegment()

Specifies an audience segment to use in the experiment.

When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

For more information, see Segment rule pattern syntax .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-segment

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Assigns one or more tags (key-value pairs) to the experiment.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an experiment.

For more information, see Tagging AWS resources .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-tags

getTreatments

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

An array of structures that describe the configuration of each feature variation used in the experiment.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnExperimentPropsMixin.TreatmentObjectProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-treatments

builder

@Stability(Stable)
static CfnExperimentMixinProps.Builder builder()

Returns:

a CfnExperimentMixinProps.Builder of CfnExperimentMixinProps