Class: AWSCDK::QuickSight::CfnTemplate::ColumnSortProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The sort configuration for a column that is not used in a field well.

See Also:

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

Instance Attribute Summary

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

  The aggregation function that is defined in the column sort.

• #direction ⇒ String readonly

  The sort direction.

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(direction:, sort_by:, aggregation_function: nil) ⇒ ColumnSortProperty constructor

  A new instance of ColumnSortProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(direction:, sort_by:, aggregation_function: nil) ⇒ ColumnSortProperty

Returns a new instance of ColumnSortProperty.

Parameters:

• direction (String) —

  The sort direction.

• sort_by (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty)
• aggregation_function (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::AggregationFunctionProperty, nil) (defaults to: nil) —

  The aggregation function that is defined in the column sort.

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

def initialize(direction:, sort_by:, aggregation_function: nil)
  @direction = direction
  Jsii::Type.check_type(@direction, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "direction")
  @sort_by = sort_by.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty.new(**sort_by.transform_keys(&:to_sym)) : sort_by
  Jsii::Type.check_type(@sort_by, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "sortBy")
  @aggregation_function = aggregation_function.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AggregationFunctionProperty.new(**aggregation_function.transform_keys(&:to_sym)) : aggregation_function
  Jsii::Type.check_type(@aggregation_function, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkFnZ3JlZ2F0aW9uRnVuY3Rpb25Qcm9wZXJ0eSJ9XX19")), "aggregationFunction") unless @aggregation_function.nil?
end

Instance Attribute Details

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

The aggregation function that is defined in the column sort.

Returns:

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

See Also:

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

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

def aggregation_function
  @aggregation_function
end

#direction ⇒ String (readonly)

The sort direction.

Returns:

• (String)

See Also:

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

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

def direction
  @direction
end

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

Returns:

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

See Also:

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

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

def sort_by
  @sort_by
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :direction => "direction",
    :sort_by => "sortBy",
    :aggregation_function => "aggregationFunction",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "direction" => @direction,
    "sortBy" => @sort_by,
    "aggregationFunction" => @aggregation_function,
  })
  result.compact
end