Skip to main content

connection_status

Creates, updates, deletes, gets or lists a connection_status resource.

Overview

Nameconnection_status
TypeResource
Idaws.ssm.connection_status

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
statusstringThe status of the connection to the managed node. (connected, notconnected)
targetstringThe ID of the managed node to check connection status.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_connection_statusselectregionRetrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

SELECT
status,
target
FROM aws.ssm.connection_status
WHERE region = '{{ region }}' -- required
;