Class: AWSCDK::QuickSight::CfnTemplate::PivotFieldSortOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The field sort options for a pivot table sort configuration.

See Also:

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

Instance Attribute Summary

• #field_id ⇒ String readonly

  The field ID for the field sort options.

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

  The sort by field for the field sort options.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_id:, sort_by:) ⇒ PivotFieldSortOptionsProperty constructor

  A new instance of PivotFieldSortOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_id:, sort_by:) ⇒ PivotFieldSortOptionsProperty

Returns a new instance of PivotFieldSortOptionsProperty.

Parameters:

• field_id (String) —

  The field ID for the field sort options.

• sort_by (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::PivotTableSortByProperty) —

  The sort by field for the field sort options.

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

def initialize(field_id:, sort_by:)
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @sort_by = sort_by.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::PivotTableSortByProperty.new(**sort_by.transform_keys(&:to_sym)) : sort_by
  Jsii::Type.check_type(@sort_by, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBpdm90VGFibGVTb3J0QnlQcm9wZXJ0eSJ9XX19")), "sortBy")
end

Instance Attribute Details

#field_id ⇒ String (readonly)

The field ID for the field sort options.

Returns:

• (String)

See Also:

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

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

def field_id
  @field_id
end

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

The sort by field for the field sort options.

Returns:

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

See Also:

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

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

def sort_by
  @sort_by
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :field_id => "fieldId",
    :sort_by => "sortBy",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "fieldId" => @field_id,
    "sortBy" => @sort_by,
  })
  result.compact
end