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.106.0 (build e852934)", date="2025-02-12T12:32:03.238Z") @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();

See Also:

  • 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