Class CfnExperiment
Creates or updates an Evidently experiment .
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnExperiment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnExperiment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html
CloudformationResource: AWS::Evidently::Experiment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Evidently;
var cfnExperiment = new CfnExperiment(this, "MyCfnExperiment", new CfnExperimentProps {
MetricGoals = new [] { new MetricGoalObjectProperty {
DesiredChange = "desiredChange",
EntityIdKey = "entityIdKey",
MetricName = "metricName",
ValueKey = "valueKey",
// the properties below are optional
EventPattern = "eventPattern",
UnitLabel = "unitLabel"
} },
Name = "name",
OnlineAbConfig = new OnlineAbConfigObjectProperty {
ControlTreatmentName = "controlTreatmentName",
TreatmentWeights = new [] { new TreatmentToWeightProperty {
SplitWeight = 123,
Treatment = "treatment"
} }
},
Project = "project",
Treatments = new [] { new TreatmentObjectProperty {
Feature = "feature",
TreatmentName = "treatmentName",
Variation = "variation",
// the properties below are optional
Description = "description"
} },
// the properties below are optional
Description = "description",
RandomizationSalt = "randomizationSalt",
RemoveSegment = false,
RunningStatus = new RunningStatusObjectProperty {
Status = "status",
// the properties below are optional
AnalysisCompleteTime = "analysisCompleteTime",
DesiredState = "desiredState",
Reason = "reason"
},
SamplingRate = 123,
Segment = "segment",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnExperiment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnExperiment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnExperiment(Construct, String, ICfnExperimentProps) |
Properties
AttrArn | The ARN of the experiment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | An optional description of the experiment. |
MetricGoals | 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. |
Name | A name for the new experiment. |
OnlineAbConfig | A structure that contains the configuration of which variation to use as the "control" version. |
Project | The name or the ARN of the project where this experiment is to be created. |
RandomizationSalt | 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. |
RemoveSegment | Set this to |
RunningStatus | A structure that you can use to start and stop the experiment. |
SamplingRate | The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. |
Segment | Specifies an audience segment to use in the experiment. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Assigns one or more tags (key-value pairs) to the experiment. |
Treatments | An array of structures that describe the configuration of each feature variation used in the experiment. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnExperiment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnExperiment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnExperiment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnExperiment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnExperiment(Construct, String, ICfnExperimentProps)
public CfnExperiment(Construct scope, string id, ICfnExperimentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnExperimentProps
Resource properties.
Properties
AttrArn
The ARN of the experiment.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
An optional description of the experiment.
public virtual string Description { get; set; }
Property Value
System.String
MetricGoals
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.
public virtual object MetricGoals { get; set; }
Property Value
System.Object
Name
A name for the new experiment.
public virtual string Name { get; set; }
Property Value
System.String
OnlineAbConfig
A structure that contains the configuration of which variation to use as the "control" version.
public virtual object OnlineAbConfig { get; set; }
Property Value
System.Object
Project
The name or the ARN of the project where this experiment is to be created.
public virtual string Project { get; set; }
Property Value
System.String
RandomizationSalt
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.
public virtual string RandomizationSalt { get; set; }
Property Value
System.String
RemoveSegment
Set this to true
to remove the segment that is associated with this experiment.
public virtual object RemoveSegment { get; set; }
Property Value
System.Object
RunningStatus
A structure that you can use to start and stop the experiment.
public virtual object RunningStatus { get; set; }
Property Value
System.Object
SamplingRate
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
public virtual Nullable<double> SamplingRate { get; set; }
Property Value
System.Nullable<System.Double>
Segment
Specifies an audience segment to use in the experiment.
public virtual string Segment { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Assigns one or more tags (key-value pairs) to the experiment.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Treatments
An array of structures that describe the configuration of each feature variation used in the experiment.
public virtual object Treatments { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>