engine_status

Creates, updates, deletes, gets or lists an engine_status resource.

Overview

Name	engine_status
Type	Resource
Id	aws.neptunedata.engine_status

Fields

The following fields are returned by SELECT queries:

get_engine_status

Name	Datatype	Description
db_engine_version	string	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-.
dfe_query_engine	string	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.
features	object	Contains status information about the features enabled on your DB cluster.
gremlin	object	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.
lab_mode	object	Contains Lab Mode settings being used by the engine.
opencypher	object	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.
role	string	Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.
rolling_back_trx_count	integer	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.
rolling_back_trx_earliest_start_time	string	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.
settings	object	Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (clusterQueryTimeoutInMs).
sparql	object	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.
start_time	string	Set to the UTC time at which the current server process started.
status	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_engine_status	select	region		Retrieves the status of the graph database on the host. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_engine_status

Retrieves the status of the graph database on the host. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.

SELECT
db_engine_version,
dfe_query_engine,
features,
gremlin,
lab_mode,
opencypher,
role,
rolling_back_trx_count,
rolling_back_trx_earliest_start_time,
settings,
sparql,
start_time,
status
FROM aws.neptunedata.engine_status
WHERE region = '{{ region }}' -- required
;