Package software.amazon.awscdk.services.evidently

Interface CfnExperiment.TreatmentObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperiment.TreatmentObjectProperty.Jsii$Proxy

Enclosing class:

CfnExperiment

@Stability(Stable)
public static interface CfnExperiment.TreatmentObjectProperty
extends software.amazon.jsii.JsiiSerializable

A structure that defines one treatment in an experiment.

A treatment is a variation of the feature that you are including in the 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.*;
 TreatmentObjectProperty treatmentObjectProperty = TreatmentObjectProperty.builder()
         .feature("feature")
         .treatmentName("treatmentName")
         .variation("variation")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExperiment.TreatmentObjectProperty.Builder	builder()
default String	getDescription()	The description of the treatment.
String	getFeature()	The name of the feature for this experiment.
String	getTreatmentName()	A name for this treatment.
String	getVariation()	The name of the variation to use for this treatment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFeature

@Stability(Stable)
@NotNull
String getFeature()

The name of the feature for this experiment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-feature

getTreatmentName

@Stability(Stable)
@NotNull
String getTreatmentName()

A name for this treatment.

It can include up to 127 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-treatmentname

getVariation

@Stability(Stable)
@NotNull
String getVariation()

The name of the variation to use for this treatment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-variation

getDescription

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

The description of the treatment.

See Also:

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

builder

@Stability(Stable)
static CfnExperiment.TreatmentObjectProperty.Builder builder()

Returns:

a CfnExperiment.TreatmentObjectProperty.Builder of CfnExperiment.TreatmentObjectProperty