2.233.0

interface TopicCalculatedFieldProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnTopicPropsMixin.TopicCalculatedFieldProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnTopicPropsMixin_TopicCalculatedFieldProperty
Javasoftware.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnTopicPropsMixin.TopicCalculatedFieldProperty
Pythonaws_cdk.mixins_preview.aws_quicksight.mixins.CfnTopicPropsMixin.TopicCalculatedFieldProperty
TypeScript @aws-cdk/mixins-preview » aws_quicksight » mixins » CfnTopicPropsMixin » TopicCalculatedFieldProperty

A structure that represents a calculated field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const topicCalculatedFieldProperty: quicksight_mixins.CfnTopicPropsMixin.TopicCalculatedFieldProperty = {
  aggregation: 'aggregation',
  allowedAggregations: ['allowedAggregations'],
  calculatedFieldDescription: 'calculatedFieldDescription',
  calculatedFieldName: 'calculatedFieldName',
  calculatedFieldSynonyms: ['calculatedFieldSynonyms'],
  cellValueSynonyms: [{
    cellValue: 'cellValue',
    synonyms: ['synonyms'],
  }],
  columnDataRole: 'columnDataRole',
  comparativeOrder: {
    specifedOrder: ['specifedOrder'],
    treatUndefinedSpecifiedValues: 'treatUndefinedSpecifiedValues',
    useOrdering: 'useOrdering',
  },
  defaultFormatting: {
    displayFormat: 'displayFormat',
    displayFormatOptions: {
      blankCellFormat: 'blankCellFormat',
      currencySymbol: 'currencySymbol',
      dateFormat: 'dateFormat',
      decimalSeparator: 'decimalSeparator',
      fractionDigits: 123,
      groupingSeparator: 'groupingSeparator',
      negativeFormat: {
        prefix: 'prefix',
        suffix: 'suffix',
      },
      prefix: 'prefix',
      suffix: 'suffix',
      unitScaler: 'unitScaler',
      useBlankCellFormat: false,
      useGrouping: false,
    },
  },
  disableIndexing: false,
  expression: 'expression',
  isIncludedInTopic: false,
  neverAggregateInFilter: false,
  nonAdditive: false,
  notAllowedAggregations: ['notAllowedAggregations'],
  semanticType: {
    falseyCellValue: 'falseyCellValue',
    falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
    subTypeName: 'subTypeName',
    truthyCellValue: 'truthyCellValue',
    truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
    typeName: 'typeName',
    typeParameters: {
      typeParametersKey: 'typeParameters',
    },
  },
  timeGranularity: 'timeGranularity',
};

Properties

NameTypeDescription
aggregation?stringThe default aggregation.
allowedAggregations?string[]The list of aggregation types that are allowed for the calculated field.
calculatedFieldDescription?stringThe calculated field description.
calculatedFieldName?stringThe calculated field name.
calculatedFieldSynonyms?string[]The other names or aliases for the calculated field.
cellValueSynonyms?IResolvable | (IResolvable | CellValueSynonymProperty)[]The other names or aliases for the calculated field cell value.
columnDataRole?stringThe column data role for a calculated field.
comparativeOrder?IResolvable | ComparativeOrderPropertyThe order in which data is displayed for the calculated field when it's used in a comparative context.
defaultFormatting?IResolvable | DefaultFormattingPropertyThe default formatting definition.
disableIndexing?boolean | IResolvableA Boolean value that indicates if a calculated field is visible in the autocomplete.
expression?stringThe calculated field expression.
isIncludedInTopic?boolean | IResolvableA boolean value that indicates if a calculated field is included in the topic.
neverAggregateInFilter?boolean | IResolvableA Boolean value that indicates whether to never aggregate calculated field in filters.
nonAdditive?boolean | IResolvableThe non additive for the table style target.
notAllowedAggregations?string[]The list of aggregation types that are not allowed for the calculated field.
semanticType?IResolvable | SemanticTypePropertyThe semantic type.
timeGranularity?stringThe level of time precision that is used to aggregate DateTime values.

aggregation?

Type: string (optional)

The default aggregation.

Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-aggregation

allowedAggregations?

Type: string[] (optional)

The list of aggregation types that are allowed for the calculated field.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-allowedaggregations

calculatedFieldDescription?

Type: string (optional)

The calculated field description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfielddescription

calculatedFieldName?

Type: string (optional)

The calculated field name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldname

calculatedFieldSynonyms?

Type: string[] (optional)

The other names or aliases for the calculated field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldsynonyms

cellValueSynonyms?

Type: IResolvable | (IResolvable | CellValueSynonymProperty)[] (optional)

The other names or aliases for the calculated field cell value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-cellvaluesynonyms

columnDataRole?

Type: string (optional)

The column data role for a calculated field.

Valid values for this structure are DIMENSION and MEASURE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-columndatarole

comparativeOrder?

Type: IResolvable | ComparativeOrderProperty (optional)

The order in which data is displayed for the calculated field when it's used in a comparative context.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-comparativeorder

defaultFormatting?

Type: IResolvable | DefaultFormattingProperty (optional)

The default formatting definition.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-defaultformatting

disableIndexing?

Type: boolean | IResolvable (optional)

A Boolean value that indicates if a calculated field is visible in the autocomplete.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-disableindexing

expression?

Type: string (optional)

The calculated field expression.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-expression

isIncludedInTopic?

Type: boolean | IResolvable (optional, default: false)

A boolean value that indicates if a calculated field is included in the topic.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-isincludedintopic

neverAggregateInFilter?

Type: boolean | IResolvable (optional, default: false)

A Boolean value that indicates whether to never aggregate calculated field in filters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-neveraggregateinfilter

nonAdditive?

Type: boolean | IResolvable (optional, default: false)

The non additive for the table style target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-nonadditive

notAllowedAggregations?

Type: string[] (optional)

The list of aggregation types that are not allowed for the calculated field.

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-notallowedaggregations

semanticType?

Type: IResolvable | SemanticTypeProperty (optional)

The semantic type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-semantictype

timeGranularity?

Type: string (optional)

The level of time precision that is used to aggregate DateTime values.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-timegranularity

← PreviousNext →