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

Class CfnExperimentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnExperimentPropsMixin

All Implemented Interfaces:

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

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

Creates or updates an Evidently experiment .

Before you create an experiment, you must create the feature to use for the experiment.

An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnExperimentPropsMixin cfnExperimentPropsMixin = CfnExperimentPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnExperimentPropsMixin.Builder	A fluent builder for CfnExperimentPropsMixin.
static interface	CfnExperimentPropsMixin.MetricGoalObjectProperty	Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
static interface	CfnExperimentPropsMixin.OnlineAbConfigObjectProperty	A structure that contains the configuration of which variation to use as the "control" version.
static interface	CfnExperimentPropsMixin.RunningStatusObjectProperty	Use this structure to start and stop the experiment.
static interface	CfnExperimentPropsMixin.TreatmentObjectProperty	A structure that defines one treatment in an experiment.
static interface	CfnExperimentPropsMixin.TreatmentToWeightProperty	This structure defines how much experiment traffic to allocate to one treatment used in the experiment.

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
	CfnExperimentPropsMixin(CfnExperimentMixinProps props)	Create a mixin to apply properties to AWS::Evidently::Experiment.
	CfnExperimentPropsMixin(CfnExperimentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Evidently::Experiment.
protected	CfnExperimentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnExperimentPropsMixin(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 CfnExperimentMixinProps	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

CfnExperimentPropsMixin

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

CfnExperimentPropsMixin

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

CfnExperimentPropsMixin

@Stability(Stable)
public CfnExperimentPropsMixin(@NotNull
 CfnExperimentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Evidently::Experiment.

Parameters:

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

options - Mixin options.

CfnExperimentPropsMixin

@Stability(Stable)
public CfnExperimentPropsMixin(@NotNull
 CfnExperimentMixinProps props)

Create a mixin to apply properties to AWS::Evidently::Experiment.

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 CfnExperimentMixinProps getProps()

getStrategy

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