Package software.amazon.awscdk.services.evidently

Interface CfnExperimentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperimentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.713Z")
@Stability(Stable)
public interface CfnExperimentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnExperiment.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExperimentProps.Builder	builder()
default String	getDescription()	An optional description of the experiment.
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.
String	getName()	A name for the new experiment.
Object	getOnlineAbConfig()	A structure that contains the configuration of which variation to use as the "control" version.
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.
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

getMetricGoals

@Stability(Stable)
@NotNull
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.

getName

@Stability(Stable)
@NotNull
String getName()

A name for the new experiment.

getOnlineAbConfig

@Stability(Stable)
@NotNull
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.

getProject

@Stability(Stable)
@NotNull
String getProject()

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

getTreatments

@Stability(Stable)
@NotNull
Object getTreatments()

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

getDescription

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

An optional description of the experiment.

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 .

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.

getRunningStatus

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

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

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.

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 .

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 .

builder

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

Returns:

a CfnExperimentProps.Builder of CfnExperimentProps