Package software.amazon.awscdk.cfnpropertymixins.services.evidently

Class CfnExperimentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.evidently.CfnExperimentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnExperimentPropsMixin>

Enclosing class:

CfnExperimentPropsMixin

@Stability(Stable)
public static final class CfnExperimentPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnExperimentPropsMixin>

A fluent builder for CfnExperimentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnExperimentPropsMixin	build()
static CfnExperimentPropsMixin.Builder	create()
static CfnExperimentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnExperimentPropsMixin.Builder	description(String description)	An optional description of the experiment.
CfnExperimentPropsMixin.Builder	metricGoals(List<? extends Object> 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.
CfnExperimentPropsMixin.Builder	metricGoals(IResolvable 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.
CfnExperimentPropsMixin.Builder	name(String name)	A name for the new experiment.
CfnExperimentPropsMixin.Builder	onlineAbConfig(CfnExperimentPropsMixin.OnlineAbConfigObjectProperty onlineAbConfig)	A structure that contains the configuration of which variation to use as the "control" version.
CfnExperimentPropsMixin.Builder	onlineAbConfig(IResolvable onlineAbConfig)	A structure that contains the configuration of which variation to use as the "control" version.
CfnExperimentPropsMixin.Builder	project(String project)	The name or the ARN of the project where this experiment is to be created.
CfnExperimentPropsMixin.Builder	randomizationSalt(String 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.
CfnExperimentPropsMixin.Builder	removeSegment(Boolean removeSegment)	Set this to true to remove the segment that is associated with this experiment.
CfnExperimentPropsMixin.Builder	removeSegment(IResolvable removeSegment)	Set this to true to remove the segment that is associated with this experiment.
CfnExperimentPropsMixin.Builder	runningStatus(CfnExperimentPropsMixin.RunningStatusObjectProperty runningStatus)	A structure that you can use to start and stop the experiment.
CfnExperimentPropsMixin.Builder	runningStatus(IResolvable runningStatus)	A structure that you can use to start and stop the experiment.
CfnExperimentPropsMixin.Builder	samplingRate(Number samplingRate)	The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
CfnExperimentPropsMixin.Builder	segment(String segment)	Specifies an audience segment to use in the experiment.
CfnExperimentPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Assigns one or more tags (key-value pairs) to the experiment.
CfnExperimentPropsMixin.Builder	treatments(List<? extends Object> treatments)	An array of structures that describe the configuration of each feature variation used in the experiment.
CfnExperimentPropsMixin.Builder	treatments(IResolvable treatments)	An array of structures that describe the configuration of each feature variation used in the experiment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnExperimentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnExperimentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnExperimentPropsMixin.Builder create()

Returns:

a new instance of CfnExperimentPropsMixin.Builder.

description

@Stability(Stable)
public CfnExperimentPropsMixin.Builder description(String description)

An optional description of the experiment.

Parameters:

description - An optional description of the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-description

metricGoals

@Stability(Stable)
public CfnExperimentPropsMixin.Builder metricGoals(IResolvable 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.

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-metricgoals

metricGoals

@Stability(Stable)
public CfnExperimentPropsMixin.Builder metricGoals(List<? extends Object> 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.

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-metricgoals

name

@Stability(Stable)
public CfnExperimentPropsMixin.Builder name(String name)

A name for the new experiment.

Parameters:

name - A name for the new experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-name

onlineAbConfig

@Stability(Stable)
public CfnExperimentPropsMixin.Builder onlineAbConfig(IResolvable 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.

Parameters:

onlineAbConfig - A structure that contains the configuration of which variation to use as the "control" version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-onlineabconfig

onlineAbConfig

@Stability(Stable)
public CfnExperimentPropsMixin.Builder onlineAbConfig(CfnExperimentPropsMixin.OnlineAbConfigObjectProperty 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.

Parameters:

onlineAbConfig - A structure that contains the configuration of which variation to use as the "control" version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-onlineabconfig

project

@Stability(Stable)
public CfnExperimentPropsMixin.Builder project(String project)

The name or the ARN of the project where this experiment is to be created.

Parameters:

project - The name or the ARN of the project where this experiment is to be created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-project

randomizationSalt

@Stability(Stable)
public CfnExperimentPropsMixin.Builder randomizationSalt(String 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 .

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 parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-randomizationsalt

removeSegment

@Stability(Stable)
public CfnExperimentPropsMixin.Builder removeSegment(Boolean 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.

Parameters:

removeSegment - Set this to true to remove the segment that is associated with this experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-removesegment

removeSegment

@Stability(Stable)
public CfnExperimentPropsMixin.Builder removeSegment(IResolvable 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.

Parameters:

removeSegment - Set this to true to remove the segment that is associated with this experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-removesegment

runningStatus

@Stability(Stable)
public CfnExperimentPropsMixin.Builder runningStatus(IResolvable runningStatus)

A structure that you can use to start and stop the experiment.

Parameters:

runningStatus - A structure that you can use to start and stop the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-runningstatus

runningStatus

@Stability(Stable)
public CfnExperimentPropsMixin.Builder runningStatus(CfnExperimentPropsMixin.RunningStatusObjectProperty runningStatus)

A structure that you can use to start and stop the experiment.

Parameters:

runningStatus - A structure that you can use to start and stop the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-runningstatus

samplingRate

@Stability(Stable)
public CfnExperimentPropsMixin.Builder samplingRate(Number 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.

Parameters:

samplingRate - The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-samplingrate

segment

@Stability(Stable)
public CfnExperimentPropsMixin.Builder segment(String 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 .

Parameters:

segment - Specifies an audience segment to use in the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-segment

tags

@Stability(Stable)
public CfnExperimentPropsMixin.Builder tags(List<? extends CfnTag> 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 .

Parameters:

tags - Assigns one or more tags (key-value pairs) to the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-tags

treatments

@Stability(Stable)
public CfnExperimentPropsMixin.Builder treatments(IResolvable treatments)

An array of structures that describe the configuration of each feature variation used in the experiment.

Parameters:

treatments - An array of structures that describe the configuration of each feature variation used in the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-treatments

treatments

@Stability(Stable)
public CfnExperimentPropsMixin.Builder treatments(List<? extends Object> treatments)

An array of structures that describe the configuration of each feature variation used in the experiment.

Parameters:

treatments - An array of structures that describe the configuration of each feature variation used in the experiment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-treatments

build

@Stability(Stable)
public CfnExperimentPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnExperimentPropsMixin>

Returns:

a newly built instance of CfnExperimentPropsMixin.