Class: AWSCDK::QuickSight::CfnTemplate::CategoricalDimensionFieldProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_template.rb

Overview

The dimension type field with categorical type columns..

See Also:

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

Instance Attribute Summary

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

  The column that is used in the CategoricalDimensionField .

• #field_id ⇒ String readonly

  The custom field ID.

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

  The format configuration of the field.

• #hierarchy_id ⇒ String^? readonly

  The custom hierarchy ID.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

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

  A new instance of CategoricalDimensionFieldProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of CategoricalDimensionFieldProperty.

Parameters:

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

  The column that is used in the CategoricalDimensionField .

• field_id (String) —

  The custom field ID.

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

  The format configuration of the field.

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

  The custom hierarchy ID.

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

def initialize(column:, field_id:, format_configuration: nil, hierarchy_id: 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")
  @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?
  @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::CfnTemplate::ColumnIdentifierProperty (readonly)

The column that is used in the CategoricalDimensionField .

Returns:

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

See Also:

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

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

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-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-fieldid

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

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-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-formatconfiguration

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

def format_configuration
  @format_configuration
end

#hierarchy_id ⇒ String^? (readonly)

The custom hierarchy ID.

Returns:

• (String, nil)

See Also:

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

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

def hierarchy_id
  @hierarchy_id
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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