Class CfnExperiment
A CloudFormation AWS::Evidently::Experiment
.
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.AWS.Evidently.dll
Syntax (csharp)
public class CfnExperiment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnExperiment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates or updates an Evidently experiment . 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.
CloudformationResource: AWS::Evidently::Experiment
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html
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(Construct, String, ICfnExperimentProps) | Create a new |
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 |
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 | 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(Construct, String, ICfnExperimentProps)
Create a new AWS::Evidently::Experiment
.
public CfnExperiment(Construct scope, string id, ICfnExperimentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnExperimentProps
- resource properties.
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
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
Remarks
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
Remarks
You can use up to three metrics in an experiment.
Name
A name for the new experiment.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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
Remarks
The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
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
Remarks
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
Remarks
This randomization ID is a combination of the entity ID and randomizationSalt
. If you omit randomizationSalt
, Evidently uses the experiment name as the randomizationSalt
.
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
Remarks
You can't use this parameter if the experiment is currently running.
RunningStatus
A structure that you can use to start and stop the experiment.
public virtual object RunningStatus { get; set; }
Property Value
System.Object
Remarks
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>
Remarks
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
Specifies an audience segment to use in the experiment.
public virtual string Segment { get; set; }
Property Value
System.String
Remarks
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 .
Tags
Assigns one or more tags (key-value pairs) to the experiment.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging AWS resources .
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
Remarks
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>