Class CfnExperimentMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnExperimentMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnExperimentMixinProps>
- Enclosing interface:
CfnExperimentMixinProps
@Stability(Stable)
public static final class CfnExperimentMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnExperimentMixinProps>
A builder for
CfnExperimentMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.description(String description) Sets the value ofCfnExperimentMixinProps.getDescription()metricGoals(List<? extends Object> metricGoals) Sets the value ofCfnExperimentMixinProps.getMetricGoals()metricGoals(IResolvable metricGoals) Sets the value ofCfnExperimentMixinProps.getMetricGoals()Sets the value ofCfnExperimentMixinProps.getName()onlineAbConfig(CfnExperimentPropsMixin.OnlineAbConfigObjectProperty onlineAbConfig) Sets the value ofCfnExperimentMixinProps.getOnlineAbConfig()onlineAbConfig(IResolvable onlineAbConfig) Sets the value ofCfnExperimentMixinProps.getOnlineAbConfig()Sets the value ofCfnExperimentMixinProps.getProject()randomizationSalt(String randomizationSalt) Sets the value ofCfnExperimentMixinProps.getRandomizationSalt()removeSegment(Boolean removeSegment) Sets the value ofCfnExperimentMixinProps.getRemoveSegment()removeSegment(IResolvable removeSegment) Sets the value ofCfnExperimentMixinProps.getRemoveSegment()runningStatus(CfnExperimentPropsMixin.RunningStatusObjectProperty runningStatus) Sets the value ofCfnExperimentMixinProps.getRunningStatus()runningStatus(IResolvable runningStatus) Sets the value ofCfnExperimentMixinProps.getRunningStatus()samplingRate(Number samplingRate) Sets the value ofCfnExperimentMixinProps.getSamplingRate()Sets the value ofCfnExperimentMixinProps.getSegment()Sets the value ofCfnExperimentMixinProps.getTags()treatments(List<? extends Object> treatments) Sets the value ofCfnExperimentMixinProps.getTreatments()treatments(IResolvable treatments) Sets the value ofCfnExperimentMixinProps.getTreatments()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
description
Sets the value ofCfnExperimentMixinProps.getDescription()- Parameters:
description- An optional description of the experiment.- Returns:
this
-
metricGoals
Sets the value ofCfnExperimentMixinProps.getMetricGoals()- Parameters:
metricGoals- 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.- Returns:
this
-
metricGoals
@Stability(Stable) public CfnExperimentMixinProps.Builder metricGoals(List<? extends Object> metricGoals) Sets the value ofCfnExperimentMixinProps.getMetricGoals()- Parameters:
metricGoals- 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.- Returns:
this
-
name
Sets the value ofCfnExperimentMixinProps.getName()- Parameters:
name- A name for the new experiment.- Returns:
this
-
onlineAbConfig
@Stability(Stable) public CfnExperimentMixinProps.Builder onlineAbConfig(IResolvable onlineAbConfig) Sets the value ofCfnExperimentMixinProps.getOnlineAbConfig()- Parameters:
onlineAbConfig- 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.- Returns:
this
-
onlineAbConfig
@Stability(Stable) public CfnExperimentMixinProps.Builder onlineAbConfig(CfnExperimentPropsMixin.OnlineAbConfigObjectProperty onlineAbConfig) Sets the value ofCfnExperimentMixinProps.getOnlineAbConfig()- Parameters:
onlineAbConfig- 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.- Returns:
this
-
project
Sets the value ofCfnExperimentMixinProps.getProject()- Parameters:
project- The name or the ARN of the project where this experiment is to be created.- Returns:
this
-
randomizationSalt
@Stability(Stable) public CfnExperimentMixinProps.Builder randomizationSalt(String randomizationSalt) Sets the value ofCfnExperimentMixinProps.getRandomizationSalt()- Parameters:
randomizationSalt- 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 andrandomizationSalt. If you omitrandomizationSalt, Evidently uses the experiment name as therandomizationSalt.- Returns:
this
-
removeSegment
Sets the value ofCfnExperimentMixinProps.getRemoveSegment()- Parameters:
removeSegment- Set this totrueto remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.- Returns:
this
-
removeSegment
Sets the value ofCfnExperimentMixinProps.getRemoveSegment()- Parameters:
removeSegment- Set this totrueto remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.- Returns:
this
-
runningStatus
Sets the value ofCfnExperimentMixinProps.getRunningStatus()- Parameters:
runningStatus- A structure that you can use to start and stop the experiment.- Returns:
this
-
runningStatus
@Stability(Stable) public CfnExperimentMixinProps.Builder runningStatus(CfnExperimentPropsMixin.RunningStatusObjectProperty runningStatus) Sets the value ofCfnExperimentMixinProps.getRunningStatus()- Parameters:
runningStatus- A structure that you can use to start and stop the experiment.- Returns:
this
-
samplingRate
Sets the value ofCfnExperimentMixinProps.getSamplingRate()- Parameters:
samplingRate- 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.
- Returns:
this
-
segment
Sets the value ofCfnExperimentMixinProps.getSegment()- Parameters:
segment- 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 .
- Returns:
this
-
tags
Sets the value ofCfnExperimentMixinProps.getTags()- Parameters:
tags- 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 .
- Returns:
this
-
treatments
Sets the value ofCfnExperimentMixinProps.getTreatments()- Parameters:
treatments- An array of structures that describe the configuration of each feature variation used in the experiment.- Returns:
this
-
treatments
@Stability(Stable) public CfnExperimentMixinProps.Builder treatments(List<? extends Object> treatments) Sets the value ofCfnExperimentMixinProps.getTreatments()- Parameters:
treatments- An array of structures that describe the configuration of each feature variation used in the experiment.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnExperimentMixinProps>- Returns:
- a new instance of
CfnExperimentMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-