connection_status
Creates, updates, deletes, gets or lists a connection_status resource.
Overview
| Name | connection_status |
| Type | Resource |
| Id | aws.ssm.connection_status |
Fields
The following fields are returned by SELECT queries:
- get_connection_status
| Name | Datatype | Description |
|---|---|---|
status | string | The status of the connection to the managed node. (connected, notconnected) |
target | string | The ID of the managed node to check connection status. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_connection_status | select | region | Retrieves 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_connection_status
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
;