Class: AWSCDK::QuickSight::CfnDashboard::DashboardVersionDefinitionProperty

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

Overview

The contents of a dashboard.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_set_identifier_declarations:, analysis_defaults: nil, calculated_fields: nil, column_configurations: nil, filter_groups: nil, options: nil, parameter_declarations: nil, sheets: nil, static_files: nil) ⇒ DashboardVersionDefinitionProperty

Returns a new instance of DashboardVersionDefinitionProperty.

Parameters:



6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
 
# File 'quick_sight/cfn_dashboard.rb', line 6364

def initialize(data_set_identifier_declarations:, analysis_defaults: nil, calculated_fields: nil, column_configurations: nil, filter_groups: nil, options: nil, parameter_declarations: nil, sheets: nil, static_files: nil)
  @data_set_identifier_declarations = data_set_identifier_declarations
  Jsii::Type.check_type(@data_set_identifier_declarations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuRGF0YVNldElkZW50aWZpZXJEZWNsYXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dataSetIdentifierDeclarations")
  @analysis_defaults = analysis_defaults.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AnalysisDefaultsProperty.new(**analysis_defaults.transform_keys(&:to_sym)) : analysis_defaults
  Jsii::Type.check_type(@analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BbmFseXNpc0RlZmF1bHRzUHJvcGVydHkifV19fQ==")), "analysisDefaults") unless @analysis_defaults.nil?
  @calculated_fields = calculated_fields
  Jsii::Type.check_type(@calculated_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuQ2FsY3VsYXRlZEZpZWxkUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "calculatedFields") unless @calculated_fields.nil?
  @column_configurations = column_configurations
  Jsii::Type.check_type(@column_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuQ29sdW1uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "columnConfigurations") unless @column_configurations.nil?
  @filter_groups = filter_groups
  Jsii::Type.check_type(@filter_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuRmlsdGVyR3JvdXBQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "filterGroups") unless @filter_groups.nil?
  @options = options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AssetOptionsProperty.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Bc3NldE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "options") unless @options.nil?
  @parameter_declarations = parameter_declarations
  Jsii::Type.check_type(@parameter_declarations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuUGFyYW1ldGVyRGVjbGFyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "parameterDeclarations") unless @parameter_declarations.nil?
  @sheets = sheets
  Jsii::Type.check_type(@sheets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuU2hlZXREZWZpbml0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "sheets") unless @sheets.nil?
  @static_files = static_files
  Jsii::Type.check_type(@static_files, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuU3RhdGljRmlsZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "staticFiles") unless @static_files.nil?
end

Instance Attribute Details

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

Returns:

See Also:



6394
6395
6396
 
# File 'quick_sight/cfn_dashboard.rb', line 6394

def analysis_defaults
  @analysis_defaults
end

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

An array of calculated field definitions for the dashboard.

Returns:

See Also:



6399
6400
6401
 
# File 'quick_sight/cfn_dashboard.rb', line 6399

def calculated_fields
  @calculated_fields
end

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

An array of dashboard-level column configurations.

Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

Returns:

See Also:



6406
6407
6408
 
# File 'quick_sight/cfn_dashboard.rb', line 6406

def column_configurations
  @column_configurations
end

#data_set_identifier_declarations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::DataSetIdentifierDeclarationProperty> (readonly)

An array of dataset identifier declarations.

With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Returns:

See Also:



6391
6392
6393
 
# File 'quick_sight/cfn_dashboard.rb', line 6391

def data_set_identifier_declarations
  @data_set_identifier_declarations
end

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

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide .

Returns:

See Also:



6413
6414
6415
 
# File 'quick_sight/cfn_dashboard.rb', line 6413

def filter_groups
  @filter_groups
end

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

An array of option definitions for a dashboard.

Returns:

See Also:



6418
6419
6420
 
# File 'quick_sight/cfn_dashboard.rb', line 6418

def options
  @options
end

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

The parameter declarations for a dashboard.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide .

Returns:

See Also:



6427
6428
6429
 
# File 'quick_sight/cfn_dashboard.rb', line 6427

def parameter_declarations
  @parameter_declarations
end

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

An array of sheet definitions for a dashboard.

Returns:

See Also:



6432
6433
6434
 
# File 'quick_sight/cfn_dashboard.rb', line 6432

def sheets
  @sheets
end

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

The static files for the definition.

Returns:

See Also:



6437
6438
6439
 
# File 'quick_sight/cfn_dashboard.rb', line 6437

def static_files
  @static_files
end

Class Method Details

.jsii_properties ⇒ Object 



6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
 
# File 'quick_sight/cfn_dashboard.rb', line 6439

def self.jsii_properties
  {
    :data_set_identifier_declarations => "dataSetIdentifierDeclarations",
    :analysis_defaults => "analysisDefaults",
    :calculated_fields => "calculatedFields",
    :column_configurations => "columnConfigurations",
    :filter_groups => "filterGroups",
    :options => "options",
    :parameter_declarations => "parameterDeclarations",
    :sheets => "sheets",
    :static_files => "staticFiles",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
 
# File 'quick_sight/cfn_dashboard.rb', line 6453

def to_jsii
  result = {}
  result.merge!({
    "dataSetIdentifierDeclarations" => @data_set_identifier_declarations,
    "analysisDefaults" => @analysis_defaults,
    "calculatedFields" => @calculated_fields,
    "columnConfigurations" => @column_configurations,
    "filterGroups" => @filter_groups,
    "options" => @options,
    "parameterDeclarations" => @parameter_declarations,
    "sheets" => @sheets,
    "staticFiles" => @static_files,
  })
  result.compact
end