Class: AWSCDK::QuickSight::CfnDashboard::PivotTableFieldOptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::PivotTableFieldOptionProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The selected field options for the pivot table field options.

See Also:

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

Instance Attribute Summary

• #custom_label ⇒ String^? readonly

  The custom label of the pivot table field.

• #field_id ⇒ String readonly

  The field ID of the pivot table field.

• #visibility ⇒ String^? readonly

  The visibility of the pivot table field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_id:, custom_label: nil, visibility: nil) ⇒ PivotTableFieldOptionProperty constructor

  A new instance of PivotTableFieldOptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_id:, custom_label: nil, visibility: nil) ⇒ PivotTableFieldOptionProperty

Returns a new instance of PivotTableFieldOptionProperty.

Parameters:

• field_id (String) —

  The field ID of the pivot table field.

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

  The custom label of the pivot table field.

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

  The visibility of the pivot table field.

# File 'quick_sight/cfn_dashboard.rb', line 23015

def initialize(field_id:, custom_label: nil, visibility: nil)
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @custom_label = custom_label
  Jsii::Type.check_type(@custom_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customLabel") unless @custom_label.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#custom_label ⇒ String^? (readonly)

The custom label of the pivot table field.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-customlabel

# File 'quick_sight/cfn_dashboard.rb', line 23033

def custom_label
  @custom_label
end

#field_id ⇒ String (readonly)

The field ID of the pivot table field.

Returns:

• (String)

See Also:

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

# File 'quick_sight/cfn_dashboard.rb', line 23028

def field_id
  @field_id
end

#visibility ⇒ String^? (readonly)

The visibility of the pivot table field.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-visibility

# File 'quick_sight/cfn_dashboard.rb', line 23038

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 23040

def self.jsii_properties
  {
    :field_id => "fieldId",
    :custom_label => "customLabel",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 23048

def to_jsii
  result = {}
  result.merge!({
    "fieldId" => @field_id,
    "customLabel" => @custom_label,
    "visibility" => @visibility,
  })
  result.compact
end