Skip to content
v2.274.0

NamedEntityDefinitionProperty Struct ​

A structure that represents a named entity.

Example ​

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

Properties ​

fieldNameoptionalstringfield_nameoptionalstrfieldNameoptionalStringFieldNameoptionalstringFieldNameoptional*string#
The name of the entity.
metricoptionalIResolvable | CfnTopic.NamedEntityDefinitionMetricPropertymetricoptionaltyping.Union[IResolvable, NamedEntityDefinitionMetricProperty]metricoptionalIResolvableMetricoptionalIResolvableMetricoptionalinterface{}#
The definition of a metric.
propertyNameoptionalstringproperty_nameoptionalstrpropertyNameoptionalStringPropertyNameoptionalstringPropertyNameoptional*string#
The property name to be used for the named entity.
propertyRoleoptionalstringproperty_roleoptionalstrpropertyRoleoptionalStringPropertyRoleoptionalstringPropertyRoleoptional*string#
The property role.

Valid values for this structure are PRIMARY and ID .

propertyUsageoptionalstringproperty_usageoptionalstrpropertyUsageoptionalStringPropertyUsageoptionalstringPropertyUsageoptional*string#
The property usage.

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