Class: AWSCDK::QuickSight::CfnTemplate::DateDimensionFieldProperty

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

Overview

The dimension type field with date type columns.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DateDimensionFieldProperty.

Parameters:



6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
 
# File 'quick_sight/cfn_template.rb', line 6793

def initialize(column:, field_id:, date_granularity: nil, 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")
  @date_granularity = date_granularity
  Jsii::Type.check_type(@date_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dateGranularity") unless @date_granularity.nil?
  @format_configuration = format_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DateTimeFormatConfigurationProperty.new(**format_configuration.transform_keys(&:to_sym)) : format_configuration
  Jsii::Type.check_type(@format_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRhdGVUaW1lRm9ybWF0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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 DateDimensionField .

Returns:

See Also:



6810
6811
6812
 
# File 'quick_sight/cfn_template.rb', line 6810

def column
  @column
end

#date_granularity ⇒ String? (readonly)

The date granularity of the DateDimensionField . Choose one of the following options:.

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Returns:

  • (String, nil)

See Also:



6830
6831
6832
 
# File 'quick_sight/cfn_template.rb', line 6830

def date_granularity
  @date_granularity
end

#field_id ⇒ String (readonly)

The custom field ID.

Returns:

  • (String)

See Also:



6815
6816
6817
 
# File 'quick_sight/cfn_template.rb', line 6815

def field_id
  @field_id
end

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

The format configuration of the field.

Returns:

See Also:



6835
6836
6837
 
# File 'quick_sight/cfn_template.rb', line 6835

def format_configuration
  @format_configuration
end

#hierarchy_id ⇒ String? (readonly)

The custom hierarchy ID.

Returns:

  • (String, nil)

See Also:



6840
6841
6842
 
# File 'quick_sight/cfn_template.rb', line 6840

def hierarchy_id
  @hierarchy_id
end

Class Method Details

.jsii_properties ⇒ Object 



6842
6843
6844
6845
6846
6847
6848
6849
6850
 
# File 'quick_sight/cfn_template.rb', line 6842

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

Instance Method Details

#to_jsii ⇒ Object 



6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
 
# File 'quick_sight/cfn_template.rb', line 6852

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