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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.698Z")
 @Stability(value=Stable)
public interface CfnExperimentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Evidently::Experiment`.

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")
                 .eventPattern("eventPattern")
                 .metricName("metricName")
                 .valueKey("valueKey")
                 // the properties below are optional
                 .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")
         .samplingRate(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnExperimentProps.Builder	builder()
default String	getDescription() `AWS::Evidently::Experiment.Description`.
Object	getMetricGoals() `AWS::Evidently::Experiment.MetricGoals`.
String	getName() `AWS::Evidently::Experiment.Name`.
Object	getOnlineAbConfig() `AWS::Evidently::Experiment.OnlineAbConfig`.
String	getProject() `AWS::Evidently::Experiment.Project`.
default String	getRandomizationSalt() `AWS::Evidently::Experiment.RandomizationSalt`.
default Number	getSamplingRate() `AWS::Evidently::Experiment.SamplingRate`.
default List<CfnTag>	getTags() `AWS::Evidently::Experiment.Tags`.
Object	getTreatments() `AWS::Evidently::Experiment.Treatments`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

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

`AWS::Evidently::Experiment.Description`.

getMetricGoals

@Stability(value=Stable)
 @NotNull
Object getMetricGoals()

`AWS::Evidently::Experiment.MetricGoals`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Evidently::Experiment.Name`.

getOnlineAbConfig

@Stability(value=Stable)
 @NotNull
Object getOnlineAbConfig()

`AWS::Evidently::Experiment.OnlineAbConfig`.

getProject

@Stability(value=Stable)
 @NotNull
String getProject()

`AWS::Evidently::Experiment.Project`.

getRandomizationSalt

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

`AWS::Evidently::Experiment.RandomizationSalt`.

getSamplingRate

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

`AWS::Evidently::Experiment.SamplingRate`.

getTags

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

`AWS::Evidently::Experiment.Tags`.

getTreatments

@Stability(value=Stable)
 @NotNull
Object getTreatments()

`AWS::Evidently::Experiment.Treatments`.

builder

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

Returns:

a CfnExperimentProps.Builder of CfnExperimentProps