aws-cdk-lib.aws_quicksight.CfnTopic.NamedEntityDefinitionProperty

interface NamedEntityDefinitionProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTopic.NamedEntityDefinitionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTopic_NamedEntityDefinitionProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTopic.NamedEntityDefinitionProperty
Pythonaws_cdk.aws_quicksight.CfnTopic.NamedEntityDefinitionProperty
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
fieldName?stringThe name of the entity.
metric?IResolvable | NamedEntityDefinitionMetricPropertyThe definition of a metric.
propertyName?stringThe property name to be used for the named entity.
propertyRole?stringThe property role.
propertyUsage?stringThe 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 .