AWS::Evidently::ExperimentCfnExperiment
Creates or updates an Evidently *experiment* . Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better.
Import
import { CfnExperiment } from 'aws-cdk-lib/aws-evidently';Or use the module namespace:
import * as evidently from 'aws-cdk-lib/aws-evidently';
// evidently.CfnExperimentProperties
Configuration passed to the constructor as CfnExperimentProps.
metricGoalsRequiredIResolvable | IResolvable | MetricGoalObjectProperty[]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.
nameRequiredstringA name for the new experiment.
onlineAbConfigRequiredIResolvable | OnlineAbConfigObjectPropertyA 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.
projectRequiredstringThe name or the ARN of the project where this experiment is to be created.
treatmentsRequiredIResolvable | IResolvable | TreatmentObjectProperty[]An array of structures that describe the configuration of each feature variation used in the experiment.
descriptionOptionalstringAn optional description of the experiment.
randomizationSaltOptionalstringWhen 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` .
removeSegmentOptionalboolean | IResolvableSet 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.
runningStatusOptionalIResolvable | RunningStatusObjectPropertyA structure that you can use to start and stop the experiment.
samplingRateOptionalnumberThe 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.
segmentOptionalstringSpecifies 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax) .
tagsOptionalCfnTag[]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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-evidentlyAWS::Evidently::Experiment