class CfnExperiment (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Evidently.CfnExperiment |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsevidently#CfnExperiment |
![]() | software.amazon.awscdk.services.evidently.CfnExperiment |
![]() | aws_cdk.aws_evidently.CfnExperiment |
![]() | aws-cdk-lib » aws_evidently » CfnExperiment |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_evidently as evidently } from 'aws-cdk-lib';
const cfnExperiment = new evidently.CfnExperiment(this, 'MyCfnExperiment', {
metricGoals: [{
desiredChange: 'desiredChange',
entityIdKey: 'entityIdKey',
metricName: 'metricName',
valueKey: 'valueKey',
// the properties below are optional
eventPattern: 'eventPattern',
unitLabel: 'unitLabel',
}],
name: 'name',
onlineAbConfig: {
controlTreatmentName: 'controlTreatmentName',
treatmentWeights: [{
splitWeight: 123,
treatment: 'treatment',
}],
},
project: 'project',
treatments: [{
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: {
status: 'status',
// the properties below are optional
analysisCompleteTime: 'analysisCompleteTime',
desiredState: 'desiredState',
reason: 'reason',
},
samplingRate: 123,
segment: 'segment',
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnExperiment(scope: Construct, id: string, props: CfnExperimentProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Experiment Props
Construct Props
Name | Type | Description |
---|---|---|
metric | IResolvable | IResolvable | Metric [] | 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 | string | A name for the new experiment. |
online | IResolvable | Online | A structure that contains the configuration of which variation to use as the "control" version. |
project | string | The name or the ARN of the project where this experiment is to be created. |
treatments | IResolvable | IResolvable | Treatment [] | An array of structures that describe the configuration of each feature variation used in the experiment. |
description? | string | An optional description of the experiment. |
randomization | string | 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. |
remove | boolean | IResolvable | Set this to true to remove the segment that is associated with this experiment. |
running | IResolvable | Running | A structure that you can use to start and stop the experiment. |
sampling | number | The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. |
segment? | string | Specifies an audience segment to use in the experiment. |
tags? | Cfn [] | Assigns one or more tags (key-value pairs) to the experiment. |
metricGoals
Type:
IResolvable
|
IResolvable
|
Metric
[]
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.
You can use up to three metrics in an experiment.
name
Type:
string
A name for the new experiment.
onlineAbConfig
Type:
IResolvable
|
Online
A structure that contains the configuration of which variation to use as the "control" version.
The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
project
Type:
string
The name or the ARN of the project where this experiment is to be created.
treatments
Type:
IResolvable
|
IResolvable
|
Treatment
[]
An array of structures that describe the configuration of each feature variation used in the experiment.
description?
Type:
string
(optional)
An optional description of the experiment.
randomizationSalt?
Type:
string
(optional)
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.
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?
Type:
boolean |
IResolvable
(optional)
Set this to true
to remove the segment that is associated with this experiment.
You can't use this parameter if the experiment is currently running.
runningStatus?
Type:
IResolvable
|
Running
(optional)
A structure that you can use to start and stop the experiment.
samplingRate?
Type:
number
(optional)
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
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?
Type:
string
(optional)
Specifies an audience segment to use in the experiment.
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?
Type:
Cfn
[]
(optional)
Assigns one or more tags (key-value pairs) to the experiment.
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 .
Properties
Name | Type | Description |
---|---|---|
attr | string | The ARN of the experiment. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
metric | IResolvable | IResolvable | Metric [] | 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 | string | A name for the new experiment. |
node | Node | The tree node. |
online | IResolvable | Online | A structure that contains the configuration of which variation to use as the "control" version. |
project | string | The name or the ARN of the project where this experiment is to be created. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
treatments | IResolvable | IResolvable | Treatment [] | An array of structures that describe the configuration of each feature variation used in the experiment. |
description? | string | An optional description of the experiment. |
randomization | string | 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. |
remove | boolean | IResolvable | Set this to true to remove the segment that is associated with this experiment. |
running | IResolvable | Running | A structure that you can use to start and stop the experiment. |
sampling | number | The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. |
segment? | string | Specifies an audience segment to use in the experiment. |
tags | Cfn [] | Assigns one or more tags (key-value pairs) to the experiment. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The ARN of the experiment.
For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
metricGoals
Type:
IResolvable
|
IResolvable
|
Metric
[]
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
Type:
string
A name for the new experiment.
node
Type:
Node
The tree node.
onlineAbConfig
Type:
IResolvable
|
Online
A structure that contains the configuration of which variation to use as the "control" version.
project
Type:
string
The name or the ARN of the project where this experiment is to be created.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
treatments
Type:
IResolvable
|
IResolvable
|
Treatment
[]
An array of structures that describe the configuration of each feature variation used in the experiment.
description?
Type:
string
(optional)
An optional description of the experiment.
randomizationSalt?
Type:
string
(optional)
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?
Type:
boolean |
IResolvable
(optional)
Set this to true
to remove the segment that is associated with this experiment.
runningStatus?
Type:
IResolvable
|
Running
(optional)
A structure that you can use to start and stop the experiment.
samplingRate?
Type:
number
(optional)
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
segment?
Type:
string
(optional)
Specifies an audience segment to use in the experiment.
tagsRaw?
Type:
Cfn
[]
(optional)
Assigns one or more tags (key-value pairs) to the experiment.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }