aws-cdk-lib.aws_quicksight.CfnTopic.TopicNamedEntityProperty

interface TopicNamedEntityProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTopic.TopicNamedEntityProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTopic_TopicNamedEntityProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTopic.TopicNamedEntityProperty
Pythonaws_cdk.aws_quicksight.CfnTopic.TopicNamedEntityProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTopic » TopicNamedEntityProperty

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 topicNamedEntityProperty: quicksight.CfnTopic.TopicNamedEntityProperty = {
  entityName: 'entityName',

  // the properties below are optional
  definition: [{
    fieldName: 'fieldName',
    metric: {
      aggregation: 'aggregation',
      aggregationFunctionParameters: {
        aggregationFunctionParametersKey: 'aggregationFunctionParameters',
      },
    },
    propertyName: 'propertyName',
    propertyRole: 'propertyRole',
    propertyUsage: 'propertyUsage',
  }],
  entityDescription: 'entityDescription',
  entitySynonyms: ['entitySynonyms'],
  semanticEntityType: {
    subTypeName: 'subTypeName',
    typeName: 'typeName',
    typeParameters: {
      typeParametersKey: 'typeParameters',
    },
  },
};

Properties

NameTypeDescription
entityNamestringThe name of the named entity.
definition?IResolvable | IResolvable | NamedEntityDefinitionProperty[]The definition of a named entity.
entityDescription?stringThe description of the named entity.
entitySynonyms?string[]The other names or aliases for the named entity.
semanticEntityType?IResolvable | SemanticEntityTypePropertyThe type of named entity that a topic represents.

entityName

Type: string

The name of the named entity.


definition?

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

The definition of a named entity.


entityDescription?

Type: string (optional)

The description of the named entity.


entitySynonyms?

Type: string[] (optional)

The other names or aliases for the named entity.


semanticEntityType?

Type: IResolvable | SemanticEntityTypeProperty (optional)

The type of named entity that a topic represents.