import { Value } from '../../../cloudformation/Value';
/**
  Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html">the AWS Docs</a>
*/
export interface MetricGoalObjectProps {
    /** <code>EntityIdKey</code>  <a name="cfn-evidently-experiment-metricgoalobject-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>DesiredChange</code>  <a name="cfn-evidently-experiment-metricgoalobject-desiredchange"></a>
  <code>INCREASE</code> means that a variation with a higher number for this metric is performing better.<br />
  <code>DECREASE</code> means that a variation with a lower number for this metric is performing better.<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> */
    desiredChange: Value<string>;
    /** <code>MetricName</code>  <a name="cfn-evidently-experiment-metricgoalobject-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-experiment-metricgoalobject-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-experiment-metricgoalobject-valuekey"></a>
  The JSON path to reference the numerical metric value in the event.<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-experiment-metricgoalobject-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>;
}
