Class CfnTopic.TopicNamedEntityProperty

A structure that represents a named entity.

Inheritance

object

CfnTopic.TopicNamedEntityProperty

Implements

CfnTopic.ITopicNamedEntityProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTopic.TopicNamedEntityProperty : CfnTopic.ITopicNamedEntityProperty

Syntax (vb)

Public Class CfnTopic.TopicNamedEntityProperty Implements CfnTopic.ITopicNamedEntityProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var topicNamedEntityProperty = new TopicNamedEntityProperty {
                 EntityName = "entityName",

                 // the properties below are optional
                 Definition = new [] { new NamedEntityDefinitionProperty {
                     FieldName = "fieldName",
                     Metric = new NamedEntityDefinitionMetricProperty {
                         Aggregation = "aggregation",
                         AggregationFunctionParameters = new Dictionary<string, string> {
                             { "aggregationFunctionParametersKey", "aggregationFunctionParameters" }
                         }
                     },
                     PropertyName = "propertyName",
                     PropertyRole = "propertyRole",
                     PropertyUsage = "propertyUsage"
                 } },
                 EntityDescription = "entityDescription",
                 EntitySynonyms = new [] { "entitySynonyms" },
                 SemanticEntityType = new SemanticEntityTypeProperty {
                     SubTypeName = "subTypeName",
                     TypeName = "typeName",
                     TypeParameters = new Dictionary<string, string> {
                         { "typeParametersKey", "typeParameters" }
                     }
                 }
             };

Synopsis

Constructors

TopicNamedEntityProperty()

A structure that represents a named entity.

Properties

Definition	The definition of a named entity.
EntityDescription	The description of the named entity.
EntityName	The name of the named entity.
EntitySynonyms	The other names or aliases for the named entity.
SemanticEntityType	The type of named entity that a topic represents.

Constructors

TopicNamedEntityProperty()

A structure that represents a named entity.

public TopicNamedEntityProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var topicNamedEntityProperty = new TopicNamedEntityProperty {
                 EntityName = "entityName",

                 // the properties below are optional
                 Definition = new [] { new NamedEntityDefinitionProperty {
                     FieldName = "fieldName",
                     Metric = new NamedEntityDefinitionMetricProperty {
                         Aggregation = "aggregation",
                         AggregationFunctionParameters = new Dictionary<string, string> {
                             { "aggregationFunctionParametersKey", "aggregationFunctionParameters" }
                         }
                     },
                     PropertyName = "propertyName",
                     PropertyRole = "propertyRole",
                     PropertyUsage = "propertyUsage"
                 } },
                 EntityDescription = "entityDescription",
                 EntitySynonyms = new [] { "entitySynonyms" },
                 SemanticEntityType = new SemanticEntityTypeProperty {
                     SubTypeName = "subTypeName",
                     TypeName = "typeName",
                     TypeParameters = new Dictionary<string, string> {
                         { "typeParametersKey", "typeParameters" }
                     }
                 }
             };

Properties

Definition

The definition of a named entity.

public object? Definition { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-definition

EntityDescription

The description of the named entity.

public string? EntityDescription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitydescription

EntityName

The name of the named entity.

public string EntityName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entityname

EntitySynonyms

The other names or aliases for the named entity.

public string[]? EntitySynonyms { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitysynonyms

SemanticEntityType

The type of named entity that a topic represents.

public object? SemanticEntityType { get; set; }