aws-native.evidently.Experiment
Explore with Pulumi AI
Resource Type definition for AWS::Evidently::Experiment.
Create Experiment Resource
new Experiment(name: string, args: ExperimentArgs, opts?: CustomResourceOptions);
@overload
def Experiment(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
metric_goals: Optional[Sequence[ExperimentMetricGoalObjectArgs]] = None,
name: Optional[str] = None,
online_ab_config: Optional[ExperimentOnlineAbConfigObjectArgs] = None,
project: 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[ExperimentTagArgs]] = None,
treatments: Optional[Sequence[ExperimentTreatmentObjectArgs]] = None)
@overload
def Experiment(resource_name: str,
args: ExperimentArgs,
opts: Optional[ResourceOptions] = 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.
- 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
The Experiment resource accepts the following input properties:
- Metric
Goals List<Pulumi.Aws Native. Evidently. Inputs. Experiment Metric Goal Object Args> - Online
Ab Pulumi.Config Aws Native. Evidently. Inputs. Experiment Online Ab Config Object Args - Project string
- Treatments
List<Pulumi.
Aws Native. Evidently. Inputs. Experiment Treatment Object Args> - Description string
- Name string
- Randomization
Salt string - Remove
Segment bool - Running
Status Pulumi.Aws Native. Evidently. Inputs. Experiment Running Status Object Args Start Experiment. Default is False
- Sampling
Rate int - Segment string
- List<Pulumi.
Aws Native. Evidently. Inputs. Experiment Tag Args> An array of key-value pairs to apply to this resource.
- Metric
Goals []ExperimentMetric Goal Object Args - Online
Ab ExperimentConfig Online Ab Config Object Args - Project string
- Treatments
[]Experiment
Treatment Object Args - Description string
- Name string
- Randomization
Salt string - Remove
Segment bool - Running
Status ExperimentRunning Status Object Args Start Experiment. Default is False
- Sampling
Rate int - Segment string
- []Experiment
Tag Args An array of key-value pairs to apply to this resource.
- metric
Goals List<ExperimentMetric Goal Object Args> - online
Ab ExperimentConfig Online Ab Config Object Args - project String
- treatments
List<Experiment
Treatment Object Args> - description String
- name String
- randomization
Salt String - remove
Segment Boolean - running
Status ExperimentRunning Status Object Args Start Experiment. Default is False
- sampling
Rate Integer - segment String
- List<Experiment
Tag Args> An array of key-value pairs to apply to this resource.
- metric
Goals ExperimentMetric Goal Object Args[] - online
Ab ExperimentConfig Online Ab Config Object Args - project string
- treatments
Experiment
Treatment Object Args[] - description string
- name string
- randomization
Salt string - remove
Segment boolean - running
Status ExperimentRunning Status Object Args Start Experiment. Default is False
- sampling
Rate number - segment string
- Experiment
Tag Args[] An array of key-value pairs to apply to this resource.
- metric_
goals Sequence[ExperimentMetric Goal Object Args] - online_
ab_ Experimentconfig Online Ab Config Object Args - project str
- treatments
Sequence[Experiment
Treatment Object Args] - description str
- name str
- randomization_
salt str - remove_
segment bool - running_
status ExperimentRunning Status Object Args Start Experiment. Default is False
- sampling_
rate int - segment str
- Sequence[Experiment
Tag Args] An array of key-value pairs to apply to this resource.
- metric
Goals List<Property Map> - online
Ab Property MapConfig - project String
- treatments List<Property Map>
- description String
- name String
- randomization
Salt String - remove
Segment Boolean - running
Status Property Map Start Experiment. Default is False
- sampling
Rate Number - segment String
- 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
- Desired
Change Pulumi.Aws Native. Evidently. Experiment Metric Goal Object Desired Change - Entity
Id stringKey The JSON path to reference the entity id in the event.
- Metric
Name string - 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
- Desired
Change ExperimentMetric Goal Object Desired Change - Entity
Id stringKey The JSON path to reference the entity id in the event.
- Metric
Name string - 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
- desired
Change ExperimentMetric Goal Object Desired Change - entity
Id StringKey The JSON path to reference the entity id in the event.
- metric
Name String - 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
- desired
Change ExperimentMetric Goal Object Desired Change - entity
Id stringKey The JSON path to reference the entity id in the event.
- metric
Name string - 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
- desired_
change ExperimentMetric Goal Object Desired Change - entity_
id_ strkey The JSON path to reference the entity id in the event.
- metric_
name str - 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
- desired
Change "INCREASE" | "DECREASE" - entity
Id StringKey The JSON path to reference the entity id in the event.
- metric
Name String - 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
ExperimentMetricGoalObjectDesiredChange
- 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
ExperimentRunningStatusObject
- 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
ExperimentTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
ExperimentTreatmentObject
- Feature string
- Treatment
Name string - Variation string
- Description string
- Feature string
- Treatment
Name string - Variation string
- Description string
- feature String
- treatment
Name String - variation String
- description String
- feature string
- treatment
Name string - variation string
- description string
- feature str
- treatment_
name str - variation str
- description str
- feature String
- treatment
Name String - variation String
- description String
ExperimentTreatmentToWeight
- Split
Weight int - Treatment string
- Split
Weight int - Treatment string
- split
Weight Integer - treatment String
- split
Weight number - treatment string
- split_
weight int - treatment str
- split
Weight Number - treatment String
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0