Class: Aws::Neptunedata::Types::GetEngineStatusOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_engine_versionString

Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by Patch-.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#dfe_query_engineString

Set to enabled if the DFE engine is fully enabled, or to viaQueryHint (the default) if the DFE engine is only used with queries that have the useDFE query hint set to true.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#featuresHash<String,Hash,Array,String,Numeric,Boolean>

Contains status information about the features enabled on your DB cluster.

Returns:

  • (Hash<String,Hash,Array,String,Numeric,Boolean>)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#gremlinTypes::QueryLanguageVersion

Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#lab_modeHash<String,String>

Contains Lab Mode settings being used by the engine.

Returns:

  • (Hash<String,String>)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#opencypherTypes::QueryLanguageVersion

Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#rolling_back_trx_countInteger

If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn't appear at all.

Returns:

  • (Integer)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#rolling_back_trx_earliest_start_timeString

Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn't appear at all.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settingsHash<String,String>

Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (clusterQueryTimeoutInMs).

Returns:

  • (Hash<String,String>)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#sparqlTypes::QueryLanguageVersion

Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeString

Set to the UTC time at which the current server process started.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Set to healthy if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to recovery.

Returns:

  • (String)


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/types.rb', line 1065

class GetEngineStatusOutput < Struct.new(
  :status,
  :start_time,
  :db_engine_version,
  :role,
  :dfe_query_engine,
  :gremlin,
  :sparql,
  :opencypher,
  :lab_mode,
  :rolling_back_trx_count,
  :rolling_back_trx_earliest_start_time,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end