AWS IoT Device SDK C: Defender
AWS IoT Device Defender library
Return to main page ↑
Configuration

Configuration settings of the Defender library

configpagemarker

AWS_IOT_SECURE_SOCKETS_METRICS_ENABLED

Enable secure sockets metrics Possible values: 0 or 1
Recommended values: 1
Default value (if undefined): 0

This macro must be defined for device defender library to collect sockets metrics correctly. Without defining it, the behavior is unknown.

#define AWS_IOT_SECURE_SOCKETS_METRICS_ENABLED (1)

AWS_IOT_DEFENDER_FORMAT

Default format for metrics data serialization.

Possible values: AWS_IOT_DEFENDER_FORMAT_CBOR (JSON is not supported for now)
Recommended values: Cbor is more compact than Json, thus more efficient.
Default value (if undefined): AWS_IOT_DEFENDER_FORMAT_CBOR

AWS_IOT_DEFENDER_USE_LONG_TAG

Use long tag or short tag for metrics report.

Possible values: 0 or 1
Recommended values: 0 to use short tag to reduce network transmit cost.
Default value (if undefined): 0

AWS_IOT_DEFENDER_DEFAULT_PERIOD_SECONDS

Default period constants if users don't provide their own.

If metrics is sent faster than 5 minutes for one "thing", it may be throttled.

Possible values: greater than or equal to 300
Recommended values: greater than or equal to 300 seconds; defender service might throttle if the period is too short
Default value (if undefined): 300

AWS_IOT_DEFENDER_MQTT_CONNECT_TIMEOUT_SECONDS

Default MQTT connect timeout.

Possible values: greater than 0
Default value (if undefined): 10

AWS_IOT_DEFENDER_MQTT_SUBSCRIBE_TIMEOUT_SECONDS

Default MQTT subscribe timeout.

Possible values: greater than 0
Default value (if undefined): 10

AWS_IOT_DEFENDER_MQTT_PUBLISH_TIMEOUT_SECONDS

Default MQTT publish timeout.

Possible values: greater than 0
Default value (if undefined): 10