AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.evidently.Experiment

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

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.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const experimentResource = new aws_native.evidently.Experiment("experimentResource", {
    metricGoals: [{
        desiredChange: aws_native.evidently.ExperimentMetricGoalObjectDesiredChange.Increase,
        entityIdKey: "string",
        metricName: "string",
        valueKey: "string",
        eventPattern: "string",
        unitLabel: "string",
    }],
    onlineAbConfig: {
        controlTreatmentName: "string",
        treatmentWeights: [{
            splitWeight: 0,
            treatment: "string",
        }],
    },
    project: "string",
    treatments: [{
        feature: "string",
        treatmentName: "string",
        variation: "string",
        description: "string",
    }],
    description: "string",
    name: "string",
    randomizationSalt: "string",
    removeSegment: false,
    runningStatus: {
        analysisCompleteTime: "string",
        desiredState: "string",
        reason: "string",
        status: "string",
    },
    samplingRate: 0,
    segment: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

Coming soon!

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<Pulumi.AwsNative.Evidently.Inputs.ExperimentMetricGoalObject>
OnlineAbConfig Pulumi.AwsNative.Evidently.Inputs.ExperimentOnlineAbConfigObject
Project string
Treatments List<Pulumi.AwsNative.Evidently.Inputs.ExperimentTreatmentObject>
Description string
Name string
RandomizationSalt string
RemoveSegment bool
RunningStatus Pulumi.AwsNative.Evidently.Inputs.ExperimentRunningStatusObject: Start Experiment. Default is False
SamplingRate int
Segment string
Tags List<Pulumi.AwsNative.Inputs.Tag>: An array of key-value pairs to apply to this resource.

MetricGoals []ExperimentMetricGoalObjectArgs
OnlineAbConfig ExperimentOnlineAbConfigObjectArgs
Project string
Treatments []ExperimentTreatmentObjectArgs
Description string
Name string
RandomizationSalt string
RemoveSegment bool
RunningStatus ExperimentRunningStatusObjectArgs: Start Experiment. Default is False
SamplingRate int
Segment string
Tags TagArgs: An array of key-value pairs to apply to this resource.

metricGoals List<ExperimentMetricGoalObject>
onlineAbConfig ExperimentOnlineAbConfigObject
project String
treatments List<ExperimentTreatmentObject>
description String
name String
randomizationSalt String
removeSegment Boolean
runningStatus ExperimentRunningStatusObject: Start Experiment. Default is False
samplingRate Integer
segment String
tags List<Tag>: An array of key-value pairs to apply to this resource.

metricGoals ExperimentMetricGoalObject[]
onlineAbConfig ExperimentOnlineAbConfigObject
project string
treatments ExperimentTreatmentObject[]
description string
name string
randomizationSalt string
removeSegment boolean
runningStatus ExperimentRunningStatusObject: Start Experiment. Default is False
samplingRate number
segment string
tags Tag[]: An array of key-value pairs to apply to this resource.

metric_goals Sequence[ExperimentMetricGoalObjectArgs]
online_ab_config ExperimentOnlineAbConfigObjectArgs
project str
treatments Sequence[ExperimentTreatmentObjectArgs]
description str
name str
randomization_salt str
remove_segment bool
running_status ExperimentRunningStatusObjectArgs: Start Experiment. Default is False
sampling_rate int
segment str
tags Sequence[TagArgs]: An array of key-value pairs to apply to this resource.

metricGoals List<Property Map>
onlineAbConfig Property Map
project String
treatments List<Property Map>
description String
name String
randomizationSalt String
removeSegment Boolean
runningStatus Property Map: Start Experiment. Default is False
samplingRate Number
segment String
tags 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:

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, ExperimentMetricGoalObjectArgs

DesiredChange Pulumi.AwsNative.Evidently.ExperimentMetricGoalObjectDesiredChange
EntityIdKey string: The JSON path to reference the entity id in the event.
MetricName string
ValueKey string: The JSON path to reference the numerical metric value 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.
UnitLabel string

DesiredChange ExperimentMetricGoalObjectDesiredChange
EntityIdKey string: The JSON path to reference the entity id in the event.
MetricName string
ValueKey string: The JSON path to reference the numerical metric value 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.
UnitLabel string

desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey String: The JSON path to reference the entity id in the event.
metricName String
valueKey String: The JSON path to reference the numerical metric value 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.
unitLabel String

desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey string: The JSON path to reference the entity id in the event.
metricName string
valueKey string: The JSON path to reference the numerical metric value 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.
unitLabel string

desired_change ExperimentMetricGoalObjectDesiredChange
entity_id_key str: 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

desiredChange "INCREASE" | "DECREASE"
entityIdKey String: The JSON path to reference the entity id in the event.
metricName String
valueKey String: The JSON path to reference the numerical metric value 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.
unitLabel String

ExperimentMetricGoalObjectDesiredChange, ExperimentMetricGoalObjectDesiredChangeArgs

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, ExperimentOnlineAbConfigObjectArgs

ControlTreatmentName string
TreatmentWeights List<Pulumi.AwsNative.Evidently.Inputs.ExperimentTreatmentToWeight>

ControlTreatmentName string
TreatmentWeights []ExperimentTreatmentToWeight

controlTreatmentName String
treatmentWeights List<ExperimentTreatmentToWeight>

controlTreatmentName string
treatmentWeights ExperimentTreatmentToWeight[]

control_treatment_name str
treatment_weights Sequence[ExperimentTreatmentToWeight]

controlTreatmentName String
treatmentWeights List<Property Map>

ExperimentRunningStatusObject, ExperimentRunningStatusObjectArgs

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