Class: AWSCDK::QuickSight::CfnAnalysis::AnalysisDefinitionProperty

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

Overview

The definition of an analysis.

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, query_execution_options: nil, sheets: nil, static_files: nil) ⇒ AnalysisDefinitionProperty

Returns a new instance of AnalysisDefinitionProperty.

Parameters:



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'quick_sight/cfn_analysis.rb', line 893

def initialize(data_set_identifier_declarations:, analysis_defaults: nil, calculated_fields: nil, column_configurations: nil, filter_groups: nil, options: nil, parameter_declarations: nil, query_execution_options: 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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5EYXRhU2V0SWRlbnRpZmllckRlY2xhcmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "dataSetIdentifierDeclarations")
  @analysis_defaults = analysis_defaults.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AnalysisDefaultsProperty.new(**analysis_defaults.transform_keys(&:to_sym)) : analysis_defaults
  Jsii::Type.check_type(@analysis_defaults, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFuYWx5c2lzRGVmYXVsdHNQcm9wZXJ0eSJ9XX19")), "analysisDefaults") unless @analysis_defaults.nil?
  @calculated_fields = calculated_fields
  Jsii::Type.check_type(@calculated_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5DYWxjdWxhdGVkRmllbGRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "calculatedFields") unless @calculated_fields.nil?
  @column_configurations = column_configurations
  Jsii::Type.check_type(@column_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5Db2x1bW5Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "columnConfigurations") unless @column_configurations.nil?
  @filter_groups = filter_groups
  Jsii::Type.check_type(@filter_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5GaWx0ZXJHcm91cFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "filterGroups") unless @filter_groups.nil?
  @options = options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::AssetOptionsProperty.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFzc2V0T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "options") unless @options.nil?
  @parameter_declarations = parameter_declarations
  Jsii::Type.check_type(@parameter_declarations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5QYXJhbWV0ZXJEZWNsYXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "parameterDeclarations") unless @parameter_declarations.nil?
  @query_execution_options = query_execution_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::QueryExecutionOptionsProperty.new(**query_execution_options.transform_keys(&:to_sym)) : query_execution_options
  Jsii::Type.check_type(@query_execution_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlF1ZXJ5RXhlY3V0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "queryExecutionOptions") unless @query_execution_options.nil?
  @sheets = sheets
  Jsii::Type.check_type(@sheets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5TaGVldERlZmluaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "sheets") unless @sheets.nil?
  @static_files = static_files
  Jsii::Type.check_type(@static_files, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5BbmFseXNpcy5TdGF0aWNGaWxlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "staticFiles") unless @static_files.nil?
end

Instance Attribute Details

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

Returns:

See Also:



925
926
927
 
# File 'quick_sight/cfn_analysis.rb', line 925

def analysis_defaults
  @analysis_defaults
end

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

An array of calculated field definitions for the analysis.

Returns:

See Also:



930
931
932
 
# File 'quick_sight/cfn_analysis.rb', line 930

def calculated_fields
  @calculated_fields
end

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

An array of analysis-level column configurations.

Column configurations can be used to set default formatting for a column to be used throughout an analysis.

Returns:

See Also:



937
938
939
 
# File 'quick_sight/cfn_analysis.rb', line 937

def column_configurations
  @column_configurations
end

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

An array of dataset identifier declarations.

This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

Returns:

See Also:



922
923
924
 
# File 'quick_sight/cfn_analysis.rb', line 922

def data_set_identifier_declarations
  @data_set_identifier_declarations
end

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

Filter definitions for an analysis.

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

Returns:

See Also:



944
945
946
 
# File 'quick_sight/cfn_analysis.rb', line 944

def filter_groups
  @filter_groups
end

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

An array of option definitions for an analysis.

Returns:

See Also:



949
950
951
 
# File 'quick_sight/cfn_analysis.rb', line 949

def options
  @options
end

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

An array of parameter declarations for an analysis.

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:



958
959
960
 
# File 'quick_sight/cfn_analysis.rb', line 958

def parameter_declarations
  @parameter_declarations
end

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

Returns:

See Also:



961
962
963
 
# File 'quick_sight/cfn_analysis.rb', line 961

def query_execution_options
  @query_execution_options
end

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

An array of sheet definitions for an analysis.

Each SheetDefinition provides detailed information about a sheet within this analysis.

Returns:

See Also:



968
969
970
 
# File 'quick_sight/cfn_analysis.rb', line 968

def sheets
  @sheets
end

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

The static files for the definition.

Returns:

See Also:



973
974
975
 
# File 'quick_sight/cfn_analysis.rb', line 973

def static_files
  @static_files
end

Class Method Details

.jsii_properties ⇒ Object 



975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'quick_sight/cfn_analysis.rb', line 975

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",
    :query_execution_options => "queryExecutionOptions",
    :sheets => "sheets",
    :static_files => "staticFiles",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'quick_sight/cfn_analysis.rb', line 990

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,
    "queryExecutionOptions" => @query_execution_options,
    "sheets" => @sheets,
    "staticFiles" => @static_files,
  })
  result.compact
end