We recommend new projects start with resources from the AWS provider.
aws-native.evidently.Experiment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Evidently::Experiment.
Create Experiment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Experiment(name: string, args: ExperimentArgs, opts?: CustomResourceOptions);
@overload
def Experiment(resource_name: str,
args: ExperimentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Experiment(resource_name: str,
opts: Optional[ResourceOptions] = None,
metric_goals: Optional[Sequence[ExperimentMetricGoalObjectArgs]] = None,
online_ab_config: Optional[ExperimentOnlineAbConfigObjectArgs] = None,
project: Optional[str] = None,
treatments: Optional[Sequence[ExperimentTreatmentObjectArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
randomization_salt: Optional[str] = None,
remove_segment: Optional[bool] = None,
running_status: Optional[ExperimentRunningStatusObjectArgs] = None,
sampling_rate: Optional[int] = None,
segment: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewExperiment(ctx *Context, name string, args ExperimentArgs, opts ...ResourceOption) (*Experiment, error)
public Experiment(string name, ExperimentArgs args, CustomResourceOptions? opts = null)
public Experiment(String name, ExperimentArgs args)
public Experiment(String name, ExperimentArgs args, CustomResourceOptions options)
type: aws-native:evidently:Experiment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExperimentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Experiment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Experiment resource accepts the following input properties:
- Metric
Goals List<Pulumi.Aws Native. Evidently. Inputs. Experiment Metric Goal Object> - 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.
- Online
Ab Pulumi.Config Aws Native. Evidently. Inputs. Experiment Online Ab Config Object - 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.
- Project string
- The name or the ARN of the project where this experiment is to be created.
- Treatments
List<Pulumi.
Aws Native. Evidently. Inputs. Experiment Treatment Object> - An array of structures that describe the configuration of each feature variation used in the experiment.
- Description string
- An optional description of the experiment.
- Name string
- A name for the new experiment.
- Randomization
Salt string - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - Remove
Segment bool - 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. - Running
Status Pulumi.Aws Native. Evidently. Inputs. Experiment Running Status Object - Start Experiment. Default is False
- Sampling
Rate int 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.
- Segment string
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 .
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Metric
Goals []ExperimentMetric Goal Object Args - 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.
- Online
Ab ExperimentConfig Online Ab Config Object Args - 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.
- Project string
- The name or the ARN of the project where this experiment is to be created.
- Treatments
[]Experiment
Treatment Object Args - An array of structures that describe the configuration of each feature variation used in the experiment.
- Description string
- An optional description of the experiment.
- Name string
- A name for the new experiment.
- Randomization
Salt string - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - Remove
Segment bool - 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. - Running
Status ExperimentRunning Status Object Args - Start Experiment. Default is False
- Sampling
Rate int 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.
- Segment string
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 .
- Tag
Args - An array of key-value pairs to apply to this resource.
- metric
Goals List<ExperimentMetric Goal Object> - 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.
- online
Ab ExperimentConfig Online Ab Config Object - 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.
- project String
- The name or the ARN of the project where this experiment is to be created.
- treatments
List<Experiment
Treatment Object> - An array of structures that describe the configuration of each feature variation used in the experiment.
- description String
- An optional description of the experiment.
- name String
- A name for the new experiment.
- randomization
Salt String - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - remove
Segment Boolean - 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. - running
Status ExperimentRunning Status Object - Start Experiment. Default is False
- sampling
Rate Integer 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.
- segment String
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 .
- List<Tag>
- An array of key-value pairs to apply to this resource.
- metric
Goals ExperimentMetric Goal Object[] - 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.
- online
Ab ExperimentConfig Online Ab Config Object - 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.
- project string
- The name or the ARN of the project where this experiment is to be created.
- treatments
Experiment
Treatment Object[] - An array of structures that describe the configuration of each feature variation used in the experiment.
- description string
- An optional description of the experiment.
- name string
- A name for the new experiment.
- randomization
Salt string - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - remove
Segment boolean - 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. - running
Status ExperimentRunning Status Object - Start Experiment. Default is False
- sampling
Rate number 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.
- segment string
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 .
- Tag[]
- An array of key-value pairs to apply to this resource.
- metric_
goals Sequence[ExperimentMetric Goal Object Args] - 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.
- online_
ab_ Experimentconfig Online Ab Config Object Args - 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.
- project str
- The name or the ARN of the project where this experiment is to be created.
- treatments
Sequence[Experiment
Treatment Object Args] - An array of structures that describe the configuration of each feature variation used in the experiment.
- description str
- An optional description of the experiment.
- name str
- A name for the new experiment.
- randomization_
salt str - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - remove_
segment bool - 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. - running_
status ExperimentRunning Status Object Args - Start Experiment. Default is False
- sampling_
rate int 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.
- segment str
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 .
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- metric
Goals List<Property Map> - 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.
- online
Ab Property MapConfig - 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.
- project String
- The name or the ARN of the project where this experiment is to be created.
- treatments List<Property Map>
- An array of structures that describe the configuration of each feature variation used in the experiment.
- description String
- An optional description of the experiment.
- name String
- A name for the new experiment.
- randomization
Salt String - 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 omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
. - remove
Segment Boolean - 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. - running
Status Property Map - Start Experiment. Default is False
- sampling
Rate Number 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.
- segment String
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 .
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Experiment resource produces the following output properties:
Supporting Types
ExperimentMetricGoalObject, ExperimentMetricGoalObjectArgs
- Desired
Change Pulumi.Aws Native. Evidently. Experiment Metric Goal Object Desired Change INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- Entity
Id stringKey - The JSON path to reference the entity id in the event.
- Metric
Name string - A name for the metric. It can include up to 255 characters.
- Value
Key string - The JSON path to reference the numerical metric value in the event.
- Event
Pattern string - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- Unit
Label string - A label for the units that the metric is measuring.
- Desired
Change ExperimentMetric Goal Object Desired Change INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- Entity
Id stringKey - The JSON path to reference the entity id in the event.
- Metric
Name string - A name for the metric. It can include up to 255 characters.
- Value
Key string - The JSON path to reference the numerical metric value in the event.
- Event
Pattern string - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- Unit
Label string - A label for the units that the metric is measuring.
- desired
Change ExperimentMetric Goal Object Desired Change INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- entity
Id StringKey - The JSON path to reference the entity id in the event.
- metric
Name String - A name for the metric. It can include up to 255 characters.
- value
Key String - The JSON path to reference the numerical metric value in the event.
- event
Pattern String - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- unit
Label String - A label for the units that the metric is measuring.
- desired
Change ExperimentMetric Goal Object Desired Change INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- entity
Id stringKey - The JSON path to reference the entity id in the event.
- metric
Name string - A name for the metric. It can include up to 255 characters.
- value
Key string - The JSON path to reference the numerical metric value in the event.
- event
Pattern string - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- unit
Label string - A label for the units that the metric is measuring.
- desired_
change ExperimentMetric Goal Object Desired Change INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- entity_
id_ strkey - The JSON path to reference the entity id in the event.
- metric_
name str - A name for the metric. It can include up to 255 characters.
- value_
key str - The JSON path to reference the numerical metric value in the event.
- event_
pattern str - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- unit_
label str - A label for the units that the metric is measuring.
- desired
Change "INCREASE" | "DECREASE" INCREASE
means that a variation with a higher number for this metric is performing better.DECREASE
means that a variation with a lower number for this metric is performing better.- entity
Id StringKey - The JSON path to reference the entity id in the event.
- metric
Name String - A name for the metric. It can include up to 255 characters.
- value
Key String - The JSON path to reference the numerical metric value in the event.
- event
Pattern String - Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
- unit
Label String - A label for the units that the metric is measuring.
ExperimentMetricGoalObjectDesiredChange, ExperimentMetricGoalObjectDesiredChangeArgs
- Increase
- INCREASE
- Decrease
- DECREASE
- Experiment
Metric Goal Object Desired Change Increase - INCREASE
- Experiment
Metric Goal Object Desired Change Decrease - DECREASE
- Increase
- INCREASE
- Decrease
- DECREASE
- Increase
- INCREASE
- Decrease
- DECREASE
- INCREASE
- INCREASE
- DECREASE
- DECREASE
- "INCREASE"
- INCREASE
- "DECREASE"
- DECREASE
ExperimentOnlineAbConfigObject, ExperimentOnlineAbConfigObjectArgs
- Control
Treatment stringName - The name of the variation that is to be the default variation that the other variations are compared to.
- Treatment
Weights List<Pulumi.Aws Native. Evidently. Inputs. Experiment Treatment To Weight> - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
- Control
Treatment stringName - The name of the variation that is to be the default variation that the other variations are compared to.
- Treatment
Weights []ExperimentTreatment To Weight - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
- control
Treatment StringName - The name of the variation that is to be the default variation that the other variations are compared to.
- treatment
Weights List<ExperimentTreatment To Weight> - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
- control
Treatment stringName - The name of the variation that is to be the default variation that the other variations are compared to.
- treatment
Weights ExperimentTreatment To Weight[] - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
- control_
treatment_ strname - The name of the variation that is to be the default variation that the other variations are compared to.
- treatment_
weights Sequence[ExperimentTreatment To Weight] - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
- control
Treatment StringName - The name of the variation that is to be the default variation that the other variations are compared to.
- treatment
Weights List<Property Map> - A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
ExperimentRunningStatusObject, ExperimentRunningStatusObjectArgs
- Analysis
Complete stringTime - Provide the analysis Completion time for an experiment
- Desired
State string - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- Reason string
- Reason is a required input for stopping the experiment
- Status string
- Provide START or STOP action to apply on an experiment
- Analysis
Complete stringTime - Provide the analysis Completion time for an experiment
- Desired
State string - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- Reason string
- Reason is a required input for stopping the experiment
- Status string
- Provide START or STOP action to apply on an experiment
- analysis
Complete StringTime - Provide the analysis Completion time for an experiment
- desired
State String - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- reason String
- Reason is a required input for stopping the experiment
- status String
- Provide START or STOP action to apply on an experiment
- analysis
Complete stringTime - Provide the analysis Completion time for an experiment
- desired
State string - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- reason string
- Reason is a required input for stopping the experiment
- status string
- Provide START or STOP action to apply on an experiment
- analysis_
complete_ strtime - Provide the analysis Completion time for an experiment
- desired_
state str - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- reason str
- Reason is a required input for stopping the experiment
- status str
- Provide START or STOP action to apply on an experiment
- analysis
Complete StringTime - Provide the analysis Completion time for an experiment
- desired
State String - Provide CANCELLED or COMPLETED desired state when stopping an experiment
- reason String
- Reason is a required input for stopping the experiment
- status String
- Provide START or STOP action to apply on an experiment
ExperimentTreatmentObject, ExperimentTreatmentObjectArgs
- Feature string
- The name of the feature for this experiment.
- Treatment
Name string - A name for this treatment. It can include up to 127 characters.
- Variation string
- The name of the variation to use for this treatment.
- Description string
- The description of the treatment.
- Feature string
- The name of the feature for this experiment.
- Treatment
Name string - A name for this treatment. It can include up to 127 characters.
- Variation string
- The name of the variation to use for this treatment.
- Description string
- The description of the treatment.
- feature String
- The name of the feature for this experiment.
- treatment
Name String - A name for this treatment. It can include up to 127 characters.
- variation String
- The name of the variation to use for this treatment.
- description String
- The description of the treatment.
- feature string
- The name of the feature for this experiment.
- treatment
Name string - A name for this treatment. It can include up to 127 characters.
- variation string
- The name of the variation to use for this treatment.
- description string
- The description of the treatment.
- feature str
- The name of the feature for this experiment.
- treatment_
name str - A name for this treatment. It can include up to 127 characters.
- variation str
- The name of the variation to use for this treatment.
- description str
- The description of the treatment.
- feature String
- The name of the feature for this experiment.
- treatment
Name String - A name for this treatment. It can include up to 127 characters.
- variation String
- The name of the variation to use for this treatment.
- description String
- The description of the treatment.
ExperimentTreatmentToWeight, ExperimentTreatmentToWeightArgs
- Split
Weight int - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- Treatment string
- The name of the treatment.
- Split
Weight int - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- Treatment string
- The name of the treatment.
- split
Weight Integer - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- treatment String
- The name of the treatment.
- split
Weight number - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- treatment string
- The name of the treatment.
- split_
weight int - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- treatment str
- The name of the treatment.
- split
Weight Number - The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
- treatment String
- The name of the treatment.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.