AWS Native

Pulumi Official
Package maintained by Pulumi
v0.17.0 published on Monday, May 23, 2022 by Pulumi

Experiment

Resource Type definition for AWS::Evidently::Experiment.

Create a 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,
               running_status: Optional[ExperimentRunningStatusObjectArgs] = None,
               sampling_rate: Optional[int] = 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:

metricGoals List
onlineAbConfig Property Map
project String
treatments List
description String
name String
randomizationSalt String
runningStatus Property Map

Start Experiment. Default is False

samplingRate Number
tags List

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:

Arn string
Id string

The provider-assigned unique ID for this managed resource.

Arn string
Id string

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

arn string
id string

The provider-assigned unique ID for this managed resource.

arn str
id str

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ExperimentMetricGoalObject

DesiredChange Pulumi.AwsNative.Evidently.ExperimentMetricGoalObjectDesiredChange
EntityIdKey string

The JSON path to reference the entity id in the event.

EventPattern 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.

MetricName string
ValueKey string

The JSON path to reference the numerical metric value in the event.

UnitLabel string
DesiredChange ExperimentMetricGoalObjectDesiredChange
EntityIdKey string

The JSON path to reference the entity id in the event.

EventPattern 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.

MetricName string
ValueKey string

The JSON path to reference the numerical metric value in the event.

UnitLabel string
desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey String

The JSON path to reference the entity id in the event.

eventPattern 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.

metricName String
valueKey String

The JSON path to reference the numerical metric value in the event.

unitLabel String
desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey string

The JSON path to reference the entity id in the event.

eventPattern 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.

metricName string
valueKey string

The JSON path to reference the numerical metric value in the event.

unitLabel string
desired_change ExperimentMetricGoalObjectDesiredChange
entity_id_key str

The JSON path to reference the entity id 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.

metric_name str
value_key str

The JSON path to reference the numerical metric value in the event.

unit_label str
desiredChange "INCREASE" | "DECREASE"
entityIdKey String

The JSON path to reference the entity id in the event.

eventPattern 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.

metricName String
valueKey String

The JSON path to reference the numerical metric value in the event.

unitLabel String

ExperimentMetricGoalObjectDesiredChange

Increase
INCREASE
Decrease
DECREASE
ExperimentMetricGoalObjectDesiredChangeIncrease
INCREASE
ExperimentMetricGoalObjectDesiredChangeDecrease
DECREASE
Increase
INCREASE
Decrease
DECREASE
Increase
INCREASE
Decrease
DECREASE
INCREASE
INCREASE
DECREASE
DECREASE
"INCREASE"
INCREASE
"DECREASE"
DECREASE

ExperimentOnlineAbConfigObject

ExperimentRunningStatusObject

AnalysisCompleteTime string

Provide the analysis Completion time for an experiment

DesiredState 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

AnalysisCompleteTime string

Provide the analysis Completion time for an experiment

DesiredState 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

analysisCompleteTime String

Provide the analysis Completion time for an experiment

desiredState 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

analysisCompleteTime string

Provide the analysis Completion time for an experiment

desiredState 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_time str

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

analysisCompleteTime String

Provide the analysis Completion time for an experiment

desiredState 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
TreatmentName string
Variation string
Description string
Feature string
TreatmentName string
Variation string
Description string
feature String
treatmentName String
variation String
description String
feature string
treatmentName string
variation string
description string
feature String
treatmentName String
variation String
description String

ExperimentTreatmentToWeight

splitWeight Integer
treatment String
splitWeight number
treatment string
splitWeight Number
treatment String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0