connectivity_infos

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

Overview

Name	connectivity_infos
Type	Resource
Id	aws.greengrass.connectivity_infos

Fields

The following fields are returned by SELECT queries:

get_connectivity_info

Name	Datatype	Description
connectivity_info	array	Connectivity info list.
message	string	A message about the connectivity info request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connectivity_info	select	thing_name, region		Retrieves the connectivity information for a core.
update_connectivity_info	update	thing_name, region		Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

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)
thing_name	string	The thing name.

SELECT examples

get_connectivity_info

Retrieves the connectivity information for a core.

SELECT
connectivity_info,
message
FROM aws.greengrass.connectivity_infos
WHERE thing_name = '{{ thing_name }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_connectivity_info

Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

UPDATE aws.greengrass.connectivity_infos
SET 
ConnectivityInfo = '{{ ConnectivityInfo }}'
WHERE 
thing_name = '{{ thing_name }}' --required
AND region = '{{ region }}' --required
RETURNING
message,
version;