import { Value } from '../../../cloudformation/Value';
/**
  This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html">the AWS Docs</a>
*/
export interface MetricDefinitionObjectProps {
    /** <code>EntityIdKey</code>  <a name="cfn-evidently-launch-metricdefinitionobject-entityidkey"></a>
  The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is <code>userDetails.userID</code>.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    entityIdKey: Value<string>;
    /** <code>MetricName</code>  <a name="cfn-evidently-launch-metricdefinitionobject-metricname"></a>
  A name for the metric. It can include up to 255 characters.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    metricName: Value<string>;
    /** <code>EventPattern</code>  <a name="cfn-evidently-launch-metricdefinitionobject-eventpattern"></a>
  The EventBridge event pattern that defines how the metric is recorded.<br />
  For more information about EventBridge event patterns, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    eventPattern?: Value<string>;
    /** <code>ValueKey</code>  <a name="cfn-evidently-launch-metricdefinitionobject-valuekey"></a>
  The value that is tracked to produce the metric.<br />
  
  Required: Yes<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    valueKey: Value<string>;
    /** <code>UnitLabel</code>  <a name="cfn-evidently-launch-metricdefinitionobject-unitlabel"></a>
  A label for the units that the metric is measuring.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    unitLabel?: Value<string>;
}
