import { SemanticTypeProps } from './SemanticTypeProps';
import { Value } from '../../../cloudformation/Value';
import { DefaultFormattingProps } from './DefaultFormattingProps';
import { ComparativeOrderProps } from './ComparativeOrderProps';
import { CellValueSynonymProps } from './CellValueSynonymProps';
/**
  A structure that represents a calculated field.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html">the AWS Docs</a>
*/
export interface TopicCalculatedFieldProps {
    /** <code>SemanticType</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-semantictype"></a>
  The semantic type.<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> */
    semanticType?: SemanticTypeProps;
    /** <code>NotAllowedAggregations</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-notallowedaggregations"></a>
  The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>, <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>, <code>VARP</code>, and <code>PERCENTILE</code>.<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> */
    notAllowedAggregations?: Value<Value<string>[]>;
    /** <code>DefaultFormatting</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-defaultformatting"></a>
  The default formatting definition.<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> */
    defaultFormatting?: DefaultFormattingProps;
    /** <code>AllowedAggregations</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-allowedaggregations"></a>
  The list of aggregation types that are allowed for the calculated field. Valid values for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>, <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>, <code>VARP</code>, and <code>PERCENTILE</code>.<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> */
    allowedAggregations?: Value<Value<string>[]>;
    /** <code>CalculatedFieldDescription</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-calculatedfielddescription"></a>
  The calculated field description.<br />
  
  Required: No<br />
  
  Maximum: <code>256</code><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> */
    calculatedFieldDescription?: Value<string>;
    /** <code>CalculatedFieldSynonyms</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-calculatedfieldsynonyms"></a>
  The other names or aliases for the calculated field.<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> */
    calculatedFieldSynonyms?: Value<Value<string>[]>;
    /** <code>IsIncludedInTopic</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-isincludedintopic"></a>
  A boolean value that indicates if a calculated field is included in the topic.<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> */
    isIncludedInTopic?: Value<boolean>;
    /** <code>ColumnDataRole</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-columndatarole"></a>
  The column data role for a calculated field. Valid values for this structure are <code>DIMENSION</code> and <code>MEASURE</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>DIMENSION | MEASURE</code><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> */
    columnDataRole?: Value<'DIMENSION' | 'MEASURE'>;
    /** <code>Aggregation</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-aggregation"></a>
  The default aggregation. Valid values for this structure are <code>SUM</code>, <code>MAX</code>, <code>MIN</code>, <code>COUNT</code>, <code>DISTINCT_COUNT</code>, and <code>AVERAGE</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>AVERAGE | COUNT | DISTINCT_COUNT | MAX | MEDIAN | MIN | STDEV | STDEVP | SUM | VAR | VARP</code><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> */
    aggregation?: Value<'AVERAGE' | 'COUNT' | 'DISTINCT_COUNT' | 'MAX' | 'MEDIAN' | 'MIN' | 'STDEV' | 'STDEVP' | 'SUM' | 'VAR' | 'VARP'>;
    /** <code>Expression</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-expression"></a>
  The calculated field expression.<br />
  
  Required: Yes<br />
  
  Minimum: <code>1</code><br />
  
  Maximum: <code>4096</code><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> */
    expression: Value<string>;
    /**  */
    nonAdditive?: Value<boolean>;
    /** <code>CalculatedFieldName</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-calculatedfieldname"></a>
  The calculated field name.<br />
  
  Required: Yes<br />
  
  Maximum: <code>256</code><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> */
    calculatedFieldName: Value<string>;
    /** <code>NeverAggregateInFilter</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-neveraggregateinfilter"></a>
  A Boolean value that indicates whether to never aggregate calculated field in filters.<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> */
    neverAggregateInFilter?: Value<boolean>;
    /** <code>TimeGranularity</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-timegranularity"></a>
  The level of time precision that is used to aggregate <code>DateTime</code> values.<br />
  
  Required: No<br />
  
  Allowed values: <code>DAY | HOUR | MINUTE | MONTH | QUARTER | SECOND | WEEK | YEAR</code><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> */
    timeGranularity?: Value<'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'SECOND' | 'WEEK' | 'YEAR'>;
    /** <code>ComparativeOrder</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-comparativeorder"></a>
  The order in which data is displayed for the calculated field when it’s used in a comparative context.<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> */
    comparativeOrder?: ComparativeOrderProps;
    /** <code>CellValueSynonyms</code>  <a name="cfn-quicksight-topic-topiccalculatedfield-cellvaluesynonyms"></a>
  The other names or aliases for the calculated field cell value.<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> */
    cellValueSynonyms?: CellValueSynonymProps[];
}
