Class: AWSCDK::Athena::CfnWorkGroup::EngineVersionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
athena/cfn_work_group.rb

Overview

The Athena engine version for running queries, or the PySpark engine version for running sessions.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(effective_engine_version: nil, selected_engine_version: nil) ⇒ EngineVersionProperty

Returns a new instance of EngineVersionProperty.

Parameters:

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

    Read only.

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

    The engine version requested by the user.



952
953
954
955
956
957
 
# File 'athena/cfn_work_group.rb', line 952

def initialize(effective_engine_version: nil, selected_engine_version: nil)
  @effective_engine_version = effective_engine_version
  Jsii::Type.check_type(@effective_engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "effectiveEngineVersion") unless @effective_engine_version.nil?
  @selected_engine_version = selected_engine_version
  Jsii::Type.check_type(@selected_engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selectedEngineVersion") unless @selected_engine_version.nil?
end

Instance Attribute Details

#effective_engine_version ⇒ String? (readonly)

Read only.

The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

Returns:

  • (String, nil)

See Also:



965
966
967
 
# File 'athena/cfn_work_group.rb', line 965

def effective_engine_version
  @effective_engine_version
end

#selected_engine_version ⇒ String? (readonly)

The engine version requested by the user.

Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.

Returns:

  • (String, nil)

See Also:



972
973
974
 
# File 'athena/cfn_work_group.rb', line 972

def selected_engine_version
  @selected_engine_version
end

Class Method Details

.jsii_properties ⇒ Object 



974
975
976
977
978
979
 
# File 'athena/cfn_work_group.rb', line 974

def self.jsii_properties
  {
    :effective_engine_version => "effectiveEngineVersion",
    :selected_engine_version => "selectedEngineVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



981
982
983
984
985
986
987
988
 
# File 'athena/cfn_work_group.rb', line 981

def to_jsii
  result = {}
  result.merge!({
    "effectiveEngineVersion" => @effective_engine_version,
    "selectedEngineVersion" => @selected_engine_version,
  })
  result.compact
end