interface NamedEntityDefinitionProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTopic.NamedEntityDefinitionProperty
Java	software.amazon.awscdk.services.quicksight.CfnTopic.NamedEntityDefinitionProperty
Python	aws_cdk.aws_quicksight.CfnTopic.NamedEntityDefinitionProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTopic » NamedEntityDefinitionProperty

A structure that represents a named entity.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const namedEntityDefinitionProperty: quicksight.CfnTopic.NamedEntityDefinitionProperty = {
  fieldName: 'fieldName',
  metric: {
    aggregation: 'aggregation',
    aggregationFunctionParameters: {
      aggregationFunctionParametersKey: 'aggregationFunctionParameters',
    },
  },
  propertyName: 'propertyName',
  propertyRole: 'propertyRole',
  propertyUsage: 'propertyUsage',
};

Properties

Name	Type	Description
fieldName?	string	The name of the entity.
metric?	IResolvable | NamedEntityDefinitionMetricProperty	The definition of a metric.
propertyName?	string	The property name to be used for the named entity.
propertyRole?	string	The property role.
propertyUsage?	string	The property usage.

---

fieldName?

Type: string (optional)

The name of the entity.

---

metric?

Type: IResolvable | NamedEntityDefinitionMetricProperty (optional)

The definition of a metric.

---

propertyName?

Type: string (optional)

The property name to be used for the named entity.

---

propertyRole?

Type: string (optional)

The property role.

Valid values for this structure are PRIMARY and ID .

---

propertyUsage?

Type: string (optional)

The property usage.

Valid values for this structure are INHERIT , DIMENSION , and MEASURE .