CfnExperimentProps

All Known Implementing Classes:: CfnExperimentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.379Z")
public interface CfnExperimentProps

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 and Description
`static class`	`CfnExperimentProps.Builder` A builder for `CfnExperimentProps`
`static class`	`CfnExperimentProps.Jsii$Proxy` An implementation for `CfnExperimentProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnExperimentProps.Builder`	`builder()`
`default java.lang.String`	`getDescription()` An optional description of the experiment.
`java.lang.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.
`java.lang.String`	`getName()` A name for the new experiment.
`java.lang.Object`	`getOnlineAbConfig()` A structure that contains the configuration of which variation to use as the "control" version.
`java.lang.String`	`getProject()` The name or the ARN of the project where this experiment is to be created.
`default java.lang.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 java.lang.Object`	`getRemoveSegment()` Set this to `true` to remove the segment that is associated with this experiment.
`default java.lang.Object`	`getRunningStatus()` A structure that you can use to start and stop the experiment.
`default java.lang.Number`	`getSamplingRate()` The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
`default java.lang.String`	`getSegment()` Specifies an audience segment to use in the experiment.
`default java.util.List<CfnTag>`	`getTags()` Assigns one or more tags (key-value pairs) to the experiment.
`java.lang.Object`	`getTreatments()` An array of structures that describe the configuration of each feature variation used in the experiment.

- Method Detail
  - getMetricGoals
```
java.lang.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
```
java.lang.String getName()
```
    A name for the new experiment.
  - getOnlineAbConfig
```
java.lang.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
```
java.lang.String getProject()
```
    The name or the ARN of the project where this experiment is to be created.
  - getTreatments
```
java.lang.Object getTreatments()
```
    An array of structures that describe the configuration of each feature variation used in the experiment.
  - getDescription
```
default java.lang.String getDescription()
```
    An optional description of the experiment.
  - getRandomizationSalt
```
default java.lang.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
```
default java.lang.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
```
default java.lang.Object getRunningStatus()
```
    A structure that you can use to start and stop the experiment.
  - getSamplingRate
```
default java.lang.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
```
default java.lang.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
```
default java.util.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
```
static CfnExperimentProps.Builder builder()
```
    Returns:
    
    a CfnExperimentProps.Builder of CfnExperimentProps

Interface CfnExperimentProps

Nested Class Summary

Method Summary

Method Detail

getMetricGoals

getName

getOnlineAbConfig

getProject

getTreatments

getDescription

getRandomizationSalt

getRemoveSegment

getRunningStatus

getSamplingRate

getSegment

getTags

builder