Package software.amazon.awscdk.services.evidently

Class CfnExperimentProps.Builder

java.lang.Object
software.amazon.awscdk.services.evidently.CfnExperimentProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnExperimentProps>
Enclosing interface:
CfnExperimentProps
@Stability(Stable) public static final class CfnExperimentProps.Builder extends Object implements software.amazon.jsii.Builder<CfnExperimentProps>
A builder for CfnExperimentProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metricGoals

      @Stability(Stable) public CfnExperimentProps.Builder metricGoals(IResolvable metricGoals)
      Sets the value of CfnExperimentProps.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. This parameter is required. You can use up to three metrics in an experiment.
      Returns:
      this

    • metricGoals

      @Stability(Stable) public CfnExperimentProps.Builder metricGoals(List<? extends Object> metricGoals)
      Sets the value of CfnExperimentProps.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. This parameter is required. You can use up to three metrics in an experiment.
      Returns:
      this

    • name

      @Stability(Stable) public CfnExperimentProps.Builder name(String name)
      Sets the value of CfnExperimentProps.getName()
      Parameters:
      name - A name for the new experiment. This parameter is required.
      Returns:
      this

    • onlineAbConfig

      @Stability(Stable) public CfnExperimentProps.Builder onlineAbConfig(IResolvable onlineAbConfig)
      Sets the value of CfnExperimentProps.getOnlineAbConfig()
      Parameters:
      onlineAbConfig - A structure that contains the configuration of which variation to use as the "control" version. This parameter is required. 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 CfnExperimentProps.Builder onlineAbConfig(CfnExperiment.OnlineAbConfigObjectProperty onlineAbConfig)
      Sets the value of CfnExperimentProps.getOnlineAbConfig()
      Parameters:
      onlineAbConfig - A structure that contains the configuration of which variation to use as the "control" version. This parameter is required. 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

      @Stability(Stable) public CfnExperimentProps.Builder project(String project)
      Sets the value of CfnExperimentProps.getProject()
      Parameters:
      project - The name or the ARN of the project where this experiment is to be created. This parameter is required.
      Returns:
      this

    • treatments

      @Stability(Stable) public CfnExperimentProps.Builder treatments(IResolvable treatments)
      Sets the value of CfnExperimentProps.getTreatments()
      Parameters:
      treatments - An array of structures that describe the configuration of each feature variation used in the experiment. This parameter is required.
      Returns:
      this

    • treatments

      @Stability(Stable) public CfnExperimentProps.Builder treatments(List<? extends Object> treatments)
      Sets the value of CfnExperimentProps.getTreatments()
      Parameters:
      treatments - An array of structures that describe the configuration of each feature variation used in the experiment. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnExperimentProps.Builder description(String description)
      Sets the value of CfnExperimentProps.getDescription()
      Parameters:
      description - An optional description of the experiment.
      Returns:
      this

    • randomizationSalt

      @Stability(Stable) public CfnExperimentProps.Builder randomizationSalt(String randomizationSalt)
      Sets the value of CfnExperimentProps.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 and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
      Returns:
      this

    • removeSegment

      @Stability(Stable) public CfnExperimentProps.Builder removeSegment(Boolean removeSegment)
      Sets the value of CfnExperimentProps.getRemoveSegment()
      Parameters:
      removeSegment - 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.
      Returns:
      this

    • removeSegment

      @Stability(Stable) public CfnExperimentProps.Builder removeSegment(IResolvable removeSegment)
      Sets the value of CfnExperimentProps.getRemoveSegment()
      Parameters:
      removeSegment - 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.
      Returns:
      this

    • runningStatus

      @Stability(Stable) public CfnExperimentProps.Builder runningStatus(IResolvable runningStatus)
      Sets the value of CfnExperimentProps.getRunningStatus()
      Parameters:
      runningStatus - A structure that you can use to start and stop the experiment.
      Returns:
      this

    • runningStatus

      @Stability(Stable) public CfnExperimentProps.Builder runningStatus(CfnExperiment.RunningStatusObjectProperty runningStatus)
      Sets the value of CfnExperimentProps.getRunningStatus()
      Parameters:
      runningStatus - A structure that you can use to start and stop the experiment.
      Returns:
      this

    • samplingRate

      @Stability(Stable) public CfnExperimentProps.Builder samplingRate(Number samplingRate)
      Sets the value of CfnExperimentProps.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

      @Stability(Stable) public CfnExperimentProps.Builder segment(String segment)
      Sets the value of CfnExperimentProps.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

      @Stability(Stable) public CfnExperimentProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnExperimentProps.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

    • build

      @Stability(Stable) public CfnExperimentProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnExperimentProps>
      Returns:
      a new instance of CfnExperimentProps
      Throws:
      NullPointerException - if any required attribute was not provided