interface MetricDefinitionObjectProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Evidently.CfnLaunch.MetricDefinitionObjectProperty |
 Java | software.amazon.awscdk.services.evidently.CfnLaunch.MetricDefinitionObjectProperty |
 Python | aws_cdk.aws_evidently.CfnLaunch.MetricDefinitionObjectProperty |
 TypeScript | @aws-cdk/aws-evidently » CfnLaunch » MetricDefinitionObjectProperty |
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as evidently from '@aws-cdk/aws-evidently';
const metricDefinitionObjectProperty: evidently.CfnLaunch.MetricDefinitionObjectProperty = {
entityIdKey: 'entityIdKey',
metricName: 'metricName',
valueKey: 'valueKey',
// the properties below are optional
eventPattern: 'eventPattern',
unitLabel: 'unitLabel',
};
Properties
| Name | Type | Description |
|---|---|---|
| entity | string | The entity, such as a user or session, that does an action that causes a metric value to be recorded. |
| metric | string | A name for the metric. |
| value | string | The value that is tracked to produce the metric. |
| event | string | The EventBridge event pattern that defines how the metric is recorded. |
| unit | string | A label for the units that the metric is measuring. |
entityIdKey
Type:
string
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
An example is userDetails.userID .
metricName
Type:
string
A name for the metric.
It can include up to 255 characters.
valueKey
Type:
string
The value that is tracked to produce the metric.
eventPattern?
Type:
string
(optional)
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns .
unitLabel?
Type:
string
(optional)
A label for the units that the metric is measuring.