Amazon S3 integration configuration fields

Description of the fields on the Amazon S3 integration configuration forms for Health Log Analytics.

For the Amazon S3 integration setup procedure, see Set up an Amazon S3 integration for Health Log Analytics.

Table 1. Provide details

Field	Description
Integration Name	Unique name of this integration. For example: My S3 integration. This field is required. Note: When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you entered.
Service instance	The service instance (formerly the application service) to which to bind the log data. This field is required.
Execute on	Option to select whether to use a specific MID Server or a MID Server cluster. This field is required.
MID server name	(Only when the Execute on field is set to Specific MID Server) The MID Server to which log data from Amazon S3 is pulled. This field is required. Note: You can select only MID Servers that support basic authentication. MID Servers that support mTLS are not listed. The default maximum number of data inputs streaming logs to a single MID Server is 10. You can modify this number in the MID Server properties. If log ingestion is not enabled for the selected MID Server, Health Log Analytics enables it automatically.
MID Server Cluster	(Only when Execute on is set to Specific MID Server cluster.) The MID Server cluster to which the log data is pulled. This field is required. The data input runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the data input tasks to the next available MID Server in the cluster according to the configured order. Note: Health Log Analytics supports only failover MID Server clusters. In these clusters, multiple MID Servers are grouped together for failover protection. When selecting a cluster from the data input or integration form, the MID Server clusters list displays only failover clusters. The MID Server cluster must include only MID Servers that support basic authentication. mTLS is not supported for log ingestion. Log ingestion must be enabled for each MID Server in the cluster. If log ingestion is not enabled for the active MID Server, Health Log Analytics enables it automatically. The default maximum number of data inputs or integrations streaming logs to a single MID Server is 10. A cluster passes capacity validation if it contains at least one MID Server with fewer than 10 data inputs or integrations running on it, even when that MID Server is down. For more information about MID Server clusters, see Configure a MID Server cluster.
Data source	The source of the log data that the integration pulls to your ServiceNow instance: S3. This field is read-only.
Description	Option to add a brief description of the integration to help identify it.

Table 2. Set data retrieval method

Field	Description
Bucket name	The Amazon S3 bucket to stream. This field is required.
Region	The AWS region where the Amazon CloudWatch cluster is hosted. For example: us-east-2. This field is required. For a list of AWS regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions
Authentication method	The AWS credentials needed to access resources in AWS service accounts. This field is required. Choose AWS credentials from the drop-down list, or add new AWS credentials to the list by selecting Manage Credentials and then defining new credentials on the AWS Credentials page.

Table 3. Advanced settings

Field	Description
Include	The file or object to include when the system performs pattern matching.
Exclude	The file or object to exclude when the system performs pattern matching.
Bucket prefix	The prefix for the objects to be fetched. The integration fetches only objects with this prefix. Note: This field is typically used to fetch only specific folders within a bucket.
Buffer size	The size of the download buffer, in bytes.
Threadpool size	The number of concurrent threads that are downloading files from the bucket.
Anonymous	Option to force accessing the bucket without credentials, while ignoring default credentials if they exist.
Traverse	Option to access each directory in the bucket.
Sorting object by last modified time	Option to fetch objects if the objects in the bucket are sorted by time.
Sub sample drop ratio	The number of logs to batch together, out of which one will be dropped. The default value is -1: No logs are dropped. This setting is used to reduce the number of fetched logs. For example, if you want one log out of every five to be dropped, change the value to 5.
Sleep interval (seconds)	The interval, in seconds, to wait before querying again after a query has returned no events.
Max length in bytes	The maximum length, in bytes, of events.
Connection timeout (ms)	The number of milliseconds to wait before timing out the attempt to establish a connection to AWS.
Max retry per file	The maximum number of times to retry file processing in case of failure.
Socket timeout (ms)	The number of milliseconds to wait before timing out data transfer over an established connection.
Default timezone	The default timezone if the log doesn't include timezone information.
Sub sample receive ratio	The number of logs to batch together, out of which one log will be received and the remaining ones dropped. The default value is -1: No logs are received. This setting is used to reduce the number of received logs. For example, if you want to receive one log out of every five, change the value to 5.
Polling interval	The interval, in seconds, to wait before polling for new events.
Character encoding	The character encoding used for this integration: UTF-8
Drop if queue is full	Option to select discarding logs if there is a load on the MID Server.