Class: AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionProperty

Defined in:

quick_sight/cfn_topic.rb

Overview

A structure that represents a named entity.

See Also:

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

Instance Attribute Summary

• #field_name ⇒ String^? readonly

  The name of the entity.

• #metric ⇒ AWSCDK::IResolvable, ... readonly

  The definition of a metric.

• #property_name ⇒ String^? readonly

  The property name to be used for the named entity.

• #property_role ⇒ String^? readonly

  The property role.

• #property_usage ⇒ String^? readonly

  The property usage.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_name: nil, metric: nil, property_name: nil, property_role: nil, property_usage: nil) ⇒ NamedEntityDefinitionProperty constructor

  A new instance of NamedEntityDefinitionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_name: nil, metric: nil, property_name: nil, property_role: nil, property_usage: nil) ⇒ NamedEntityDefinitionProperty

Returns a new instance of NamedEntityDefinitionProperty.

Parameters:

• field_name (String, nil) (defaults to: nil) —

  The name of the entity.

• metric (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionMetricProperty, nil) (defaults to: nil) —

  The definition of a metric.

• property_name (String, nil) (defaults to: nil) —

  The property name to be used for the named entity.

• property_role (String, nil) (defaults to: nil) —

  The property role.

• property_usage (String, nil) (defaults to: nil) —

  The property usage.

# File 'quick_sight/cfn_topic.rb', line 1180

def initialize(field_name: nil, metric: nil, property_name: nil, property_role: nil, property_usage: nil)
  @field_name = field_name
  Jsii::Type.check_type(@field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldName") unless @field_name.nil?
  @metric = metric.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionMetricProperty.new(**metric.transform_keys(&:to_sym)) : metric
  Jsii::Type.check_type(@metric, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLk5hbWVkRW50aXR5RGVmaW5pdGlvbk1ldHJpY1Byb3BlcnR5In1dfX0=")), "metric") unless @metric.nil?
  @property_name = property_name
  Jsii::Type.check_type(@property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyName") unless @property_name.nil?
  @property_role = property_role
  Jsii::Type.check_type(@property_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyRole") unless @property_role.nil?
  @property_usage = property_usage
  Jsii::Type.check_type(@property_usage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyUsage") unless @property_usage.nil?
end

Instance Attribute Details

#field_name ⇒ String^? (readonly)

The name of the entity.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-fieldname

# File 'quick_sight/cfn_topic.rb', line 1197

def field_name
  @field_name
end

#metric ⇒ AWSCDK::IResolvable, ... (readonly)

The definition of a metric.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionMetricProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-metric

# File 'quick_sight/cfn_topic.rb', line 1202

def metric
  @metric
end

#property_name ⇒ String^? (readonly)

The property name to be used for the named entity.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyname

# File 'quick_sight/cfn_topic.rb', line 1207

def property_name
  @property_name
end

#property_role ⇒ String^? (readonly)

The property role.

Valid values for this structure are PRIMARY and ID .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyrole

# File 'quick_sight/cfn_topic.rb', line 1214

def property_role
  @property_role
end

#property_usage ⇒ String^? (readonly)

The property usage.

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-namedentitydefinition.html#cfn-quicksight-topic-namedentitydefinition-propertyusage

# File 'quick_sight/cfn_topic.rb', line 1221

def property_usage
  @property_usage
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 1223

def self.jsii_properties
  {
    :field_name => "fieldName",
    :metric => "metric",
    :property_name => "propertyName",
    :property_role => "propertyRole",
    :property_usage => "propertyUsage",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 1233

def to_jsii
  result = {}
  result.merge!({
    "fieldName" => @field_name,
    "metric" => @metric,
    "propertyName" => @property_name,
    "propertyRole" => @property_role,
    "propertyUsage" => @property_usage,
  })
  result.compact
end