Class: AWSCDK::QuickSight::CfnTemplate::CategoricalMeasureFieldProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::CategoricalMeasureFieldProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The measure type field with categorical type columns.

See Also:

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

Instance Attribute Summary

• #aggregation_function ⇒ String^? readonly

  The aggregation function of the measure field.

• #column ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty readonly

  The column that is used in the CategoricalMeasureField .

• #field_id ⇒ String readonly

  The custom field ID.

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

  The format configuration of the field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(column:, field_id:, aggregation_function: nil, format_configuration: nil) ⇒ CategoricalMeasureFieldProperty constructor

  A new instance of CategoricalMeasureFieldProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(column:, field_id:, aggregation_function: nil, format_configuration: nil) ⇒ CategoricalMeasureFieldProperty

Returns a new instance of CategoricalMeasureFieldProperty.

Parameters:

• column (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty) —

  The column that is used in the CategoricalMeasureField .

• field_id (String) —

  The custom field ID.

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

  The aggregation function of the measure field.

• format_configuration (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::StringFormatConfigurationProperty, nil) (defaults to: nil) —

  The format configuration of the field.

# File 'quick_sight/cfn_template.rb', line 3233

def initialize(column:, field_id:, aggregation_function: nil, format_configuration: nil)
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "column")
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @aggregation_function = aggregation_function
  Jsii::Type.check_type(@aggregation_function, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregationFunction") unless @aggregation_function.nil?
  @format_configuration = format_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::StringFormatConfigurationProperty.new(**format_configuration.transform_keys(&:to_sym)) : format_configuration
  Jsii::Type.check_type(@format_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlN0cmluZ0Zvcm1hdENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "formatConfiguration") unless @format_configuration.nil?
end

Instance Attribute Details

#aggregation_function ⇒ String^? (readonly)

The aggregation function of the measure field.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-aggregationfunction

# File 'quick_sight/cfn_template.rb', line 3258

def aggregation_function
  @aggregation_function
end

#column ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty (readonly)

The column that is used in the CategoricalMeasureField .

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-column

# File 'quick_sight/cfn_template.rb', line 3248

def column
  @column
end

#field_id ⇒ String (readonly)

The custom field ID.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-fieldid

# File 'quick_sight/cfn_template.rb', line 3253

def field_id
  @field_id
end

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

The format configuration of the field.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::StringFormatConfigurationProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-formatconfiguration

# File 'quick_sight/cfn_template.rb', line 3263

def format_configuration
  @format_configuration
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 3265

def self.jsii_properties
  {
    :column => "column",
    :field_id => "fieldId",
    :aggregation_function => "aggregationFunction",
    :format_configuration => "formatConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 3274

def to_jsii
  result = {}
  result.merge!({
    "column" => @column,
    "fieldId" => @field_id,
    "aggregationFunction" => @aggregation_function,
    "formatConfiguration" => @format_configuration,
  })
  result.compact
end