Class: AWSCDK::QuickSight::CfnTemplate::TemplateVersionDefinitionProperty

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

Overview

The detailed definition of a template.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_set_configurations:, analysis_defaults: nil, calculated_fields: nil, column_configurations: nil, filter_groups: nil, options: nil, parameter_declarations: nil, query_execution_options: nil, sheets: nil) ⇒ TemplateVersionDefinitionProperty

Returns a new instance of TemplateVersionDefinitionProperty.

Parameters:



27071
27072
27073
27074
27075
27076
27077
27078
27079
27080
27081
27082
27083
27084
27085
27086
27087
27088
27089
27090
 
# File 'quick_sight/cfn_template.rb', line 27071

def initialize(data_set_configurations:, analysis_defaults: nil, calculated_fields: nil, column_configurations: nil, filter_groups: nil, options: nil, parameter_declarations: nil, query_execution_options: nil, sheets: nil)
  @data_set_configurations = data_set_configurations
  Jsii::Type.check_type(@data_set_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5EYXRhU2V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dataSetConfigurations")
  @analysis_defaults = analysis_defaults.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AnalysisDefaultsProperty.new(**analysis_defaults.transform_keys(&:to_sym)) : analysis_defaults
  Jsii::Type.check_type(@analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkFuYWx5c2lzRGVmYXVsdHNQcm9wZXJ0eSJ9XX19")), "analysisDefaults") unless @analysis_defaults.nil?
  @calculated_fields = calculated_fields
  Jsii::Type.check_type(@calculated_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5DYWxjdWxhdGVkRmllbGRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "calculatedFields") unless @calculated_fields.nil?
  @column_configurations = column_configurations
  Jsii::Type.check_type(@column_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5Db2x1bW5Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "columnConfigurations") unless @column_configurations.nil?
  @filter_groups = filter_groups
  Jsii::Type.check_type(@filter_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5GaWx0ZXJHcm91cFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "filterGroups") unless @filter_groups.nil?
  @options = options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AssetOptionsProperty.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkFzc2V0T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "options") unless @options.nil?
  @parameter_declarations = parameter_declarations
  Jsii::Type.check_type(@parameter_declarations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5QYXJhbWV0ZXJEZWNsYXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "parameterDeclarations") unless @parameter_declarations.nil?
  @query_execution_options = query_execution_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::QueryExecutionOptionsProperty.new(**query_execution_options.transform_keys(&:to_sym)) : query_execution_options
  Jsii::Type.check_type(@query_execution_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlF1ZXJ5RXhlY3V0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "queryExecutionOptions") unless @query_execution_options.nil?
  @sheets = sheets
  Jsii::Type.check_type(@sheets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5TaGVldERlZmluaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "sheets") unless @sheets.nil?
end

Instance Attribute Details

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

Returns:

See Also:



27101
27102
27103
 
# File 'quick_sight/cfn_template.rb', line 27101

def analysis_defaults
  @analysis_defaults
end

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

An array of calculated field definitions for the template.

Returns:

See Also:



27106
27107
27108
 
# File 'quick_sight/cfn_template.rb', line 27106

def calculated_fields
  @calculated_fields
end

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

An array of template-level column configurations.

Column configurations are used to set default formatting for a column that's used throughout a template.

Returns:

See Also:



27113
27114
27115
 
# File 'quick_sight/cfn_template.rb', line 27113

def column_configurations
  @column_configurations
end

#data_set_configurations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::DataSetConfigurationProperty> (readonly)

An array of dataset configurations.

These configurations define the required columns for each dataset used within a template.

Returns:

See Also:



27098
27099
27100
 
# File 'quick_sight/cfn_template.rb', line 27098

def data_set_configurations
  @data_set_configurations
end

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

Filter definitions for a template.

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

Returns:

See Also:



27120
27121
27122
 
# File 'quick_sight/cfn_template.rb', line 27120

def filter_groups
  @filter_groups
end

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

An array of option definitions for a template.

Returns:

See Also:



27125
27126
27127
 
# File 'quick_sight/cfn_template.rb', line 27125

def options
  @options
end

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

An array of parameter declarations for a template.

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:



27134
27135
27136
 
# File 'quick_sight/cfn_template.rb', line 27134

def parameter_declarations
  @parameter_declarations
end

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

Returns:

See Also:



27137
27138
27139
 
# File 'quick_sight/cfn_template.rb', line 27137

def query_execution_options
  @query_execution_options
end

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

An array of sheet definitions for a template.

Returns:

See Also:



27142
27143
27144
 
# File 'quick_sight/cfn_template.rb', line 27142

def sheets
  @sheets
end

Class Method Details

.jsii_properties ⇒ Object 



27144
27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
27155
27156
 
# File 'quick_sight/cfn_template.rb', line 27144

def self.jsii_properties
  {
    :data_set_configurations => "dataSetConfigurations",
    :analysis_defaults => "analysisDefaults",
    :calculated_fields => "calculatedFields",
    :column_configurations => "columnConfigurations",
    :filter_groups => "filterGroups",
    :options => "options",
    :parameter_declarations => "parameterDeclarations",
    :query_execution_options => "queryExecutionOptions",
    :sheets => "sheets",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



27158
27159
27160
27161
27162
27163
27164
27165
27166
27167
27168
27169
27170
27171
27172
 
# File 'quick_sight/cfn_template.rb', line 27158

def to_jsii
  result = {}
  result.merge!({
    "dataSetConfigurations" => @data_set_configurations,
    "analysisDefaults" => @analysis_defaults,
    "calculatedFields" => @calculated_fields,
    "columnConfigurations" => @column_configurations,
    "filterGroups" => @filter_groups,
    "options" => @options,
    "parameterDeclarations" => @parameter_declarations,
    "queryExecutionOptions" => @query_execution_options,
    "sheets" => @sheets,
  })
  result.compact
end