Class: AWSCDK::QuickSight::CfnDashboard::CategoricalDimensionFieldProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

The dimension type field with categorical type columns..

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, field_id:, format_configuration: nil, hierarchy_id: nil) ⇒ CategoricalDimensionFieldProperty

Returns a new instance of CategoricalDimensionFieldProperty.

Parameters:



3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
 
# File 'quick_sight/cfn_dashboard.rb', line 3314

def initialize(column:, field_id:, format_configuration: nil, hierarchy_id: nil)
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Db2x1bW5JZGVudGlmaWVyUHJvcGVydHkifV19fQ==")), "column")
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @format_configuration = format_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::StringFormatConfigurationProperty.new(**format_configuration.transform_keys(&:to_sym)) : format_configuration
  Jsii::Type.check_type(@format_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TdHJpbmdGb3JtYXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "formatConfiguration") unless @format_configuration.nil?
  @hierarchy_id = hierarchy_id
  Jsii::Type.check_type(@hierarchy_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyId") unless @hierarchy_id.nil?
end

Instance Attribute Details

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

The column that is used in the CategoricalDimensionField .

Returns:

See Also:



3329
3330
3331
 
# File 'quick_sight/cfn_dashboard.rb', line 3329

def column
  @column
end

#field_id ⇒ String (readonly)

The custom field ID.

Returns:

  • (String)

See Also:



3334
3335
3336
 
# File 'quick_sight/cfn_dashboard.rb', line 3334

def field_id
  @field_id
end

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

The format configuration of the field.

Returns:

See Also:



3339
3340
3341
 
# File 'quick_sight/cfn_dashboard.rb', line 3339

def format_configuration
  @format_configuration
end

#hierarchy_id ⇒ String? (readonly)

The custom hierarchy ID.

Returns:

  • (String, nil)

See Also:



3344
3345
3346
 
# File 'quick_sight/cfn_dashboard.rb', line 3344

def hierarchy_id
  @hierarchy_id
end

Class Method Details

.jsii_properties ⇒ Object 



3346
3347
3348
3349
3350
3351
3352
3353
 
# File 'quick_sight/cfn_dashboard.rb', line 3346

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

Instance Method Details

#to_jsii ⇒ Object 



3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
 
# File 'quick_sight/cfn_dashboard.rb', line 3355

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