connectivity_infos

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

Overview

Name	connectivity_infos
Type	Resource
Id	aws.greengrassv2.connectivity_infos

Fields

The following fields are returned by SELECT queries:

get_connectivity_info

Name	Datatype	Description
connectivity_info	array	The connectivity information for the core device.
message	string	A message about the connectivity information 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 connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.
update_connectivity_info	update	thing_name, region, connectivityInfo		Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

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 name of the core device. This is also the name of the IoT thing.

SELECT examples

get_connectivity_info

Retrieves connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

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

UPDATE examples

update_connectivity_info

Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

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