Protocol - S3
This page documents the s3 server configuration.
For more information related to S3 see Connect.
Note
If a HTTPS (TLS) server Endpoint is used, see S3 security for more information on how to set up certificates.
Configuration file fields
This section is autogenerated from the Rule Schema file.
Synchronization connect.s3.sync
This section configures how and when the device communicates with the S3 server.
Firmware, config and certificate connect.s3.sync.ota
Configures how often the device looks for firmware-, config- and certificate-over-the-air updates. Small values may reduce performance. Time period may sometimes become longer if device is busy. Set to 0 to disable.
Type |
Default |
Minimum |
Maximum |
Multiple of |
|---|---|---|---|---|
integer |
600 |
0 |
86400 |
5 |
Heartbeat connect.s3.sync.heartbeat
Configures how often the device transmits the heartbeat signal. Small values may reduce performance. Time period may sometimes become longer if device is busy. Set to 0 to disable.
Type |
Default |
Minimum |
Maximum |
Multiple of |
|---|---|---|---|---|
integer |
300 |
0 |
86400 |
5 |
Log files connect.s3.sync.logfiles
Configures if the device pushes closed log files to the server. The log files are deleted from the device when successfully uploaded.
Type |
Default |
Options |
|---|---|---|
integer |
1 |
Disable: |
Server connect.s3.server
This section contains the server connection parameters.
Endpoint connect.s3.server.endpoint
S3 server endpoint. Prefix with http:// to connect using standard http. Prefix with https:// to connect using SSL/TLS - requires support by the server and that the server certificate is loaded onto the device. Examples: http://192.168.0.1, https://s3.mydomain.com, https://s3.amazonaws.com, http://s3-us-east-2.amazonaws.com.
Type |
Max length |
|---|---|
string |
128 |
Port connect.s3.server.port
S3 server port. Examples: 80 (http), 443 (https), 9000 (custom).
Type |
Minimum |
Maximum |
|---|---|---|
integer |
0 |
65535 |
Bucket name connect.s3.server.bucket
S3 server bucket name. Examples: logbucket, fleetbucket, testbucket.
Type |
Max length |
|---|---|
string |
64 |
Region connect.s3.server.region
S3 server region. Example: us-east-1.
Type |
Min length |
Max length |
|---|---|---|
string |
0 |
32 |
Request style connect.s3.server.request_style
Virtual-hosted-style or path-style S3 requests. Virtual hosted-style format: “http://[BUCKET-NAME].[DOMAIN]/[OBJECT-NAME]”. Path-style format: “http://[DOMAIN]/[BUCKET-NAME]/[OBJECT-NAME]”
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Path-style: |
AccessKey connect.s3.server.accesskey
S3 server access key ID. Example: PRDDKN8R6PAAOGTEI53E
Type |
Min length |
Max length |
|---|---|---|
string |
3 |
128 |
SecretKey format connect.s3.server.keyformat
The format of the secret key. Can be used to hide the secret key stored on the device.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Plain: |
SecretKey connect.s3.server.secretkey
Type |
|---|
string |
Signed payload connect.s3.server.signed_payload
Include payload checksum in signature. Reduces device upload performance.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Off: |
Configuration explained
This section contains additional information and examples.
Warning
Ensure that the network allows communication on the S3 port (e.g. 9000)
Request-style
S3 supports two different request styles path and virtual hosted. The device supports both styles.
With the virtual hosted style, the subdomain is specific to the bucket, which makes it possible to use DNS to map a specific bucket to an IP address.
Warning
Some S3 servers may only support one of the two request formats.
Path-style http header example:
GET /[BUCKET_NAME]/[OBJECT_NAME] HTTP/1.1
Host: [DOMAIN]
...
Virtual hosted-style http header example:
GET /[OBJECT_NAME] HTTP/1.1
Host: [BUCKET_NAME].[DOMAIN]
...