Amazon CloudWatch data input configuration fields

reference brazil Updated Sep 10, 2026 5 min read hla-data-input-cloudwatch-ref.md
Raw file servicenow.com

Description of the fields on the Amazon CloudWatch data input configuration form.

Field

Description

Name

Name of the new data input. This field is required.

Description

Optional description of the data input.

Execute on

Option to select whether to use a specific MID Server or a specific MID Server cluster. This field is required.

MID

(Only when the Execute on field is set to Specific MID Server)

The MID Server to which log data from Amazon CloudWatch is pulled. Note:

  • 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.

This field is required.

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.
  • 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. This is true even when that MID Server is down.

For more information about MID Server clusters, see Configure a MID Server cluster.

Service instance

The service instance to which to bind the log data. This field is required.Selecting the service instance enables HLA to correlate CIs and service instances in the CMDB for root cause analysis.

Note: If no appropriate service instance exists, create one, add CIs to it, and set its status to Operational. For more information, see Create a Service instance (application service).

Field

Description

Status

Status of the data input. This field is read-only.

Transport

Protocol used to stream the log data. This field is read-only.This data input uses Amazon CloudWatch to stream log data to your instance.

Sources count

The number of log sources this data input has created. This field is read-only.

Disabled since

The time when the data input stopped or failed. This field is read-only.

MID last receiving time

The time when the last log streamed in the data input.

Error message

The streaming error.This field is populated automatically. It displays only when a streaming error has occurred.

Advanced

Option to display the Advanced tab for advanced configuration.

Field

Description

Example

From

The date and time to start reading the data. Data older than this date and time is not read.Note: Setting this value to a past date might require the system to read large amounts of data, causing congestion.

This field is required.

Now -1 week

Group Name(s)

The log groups to search. If multiple log groups must be searched, specify the groups in a comma-separated list. To fetch log data from all groups, use an asterisk (*) as a wildcard character.This field is required.

hla-cw-loggroup1,hla-cw-loggroup2

Prefix

Name prefix for the Amazon CloudWatch log streams to read from. The data input reads only from log streams with this name prefix.Note: Only a single log stream prefix per data item is supported. For multiple prefixes, create multiple data inputs.

hla-cw

Filter pattern

Pattern by which to filter incoming events. Various types of filter patterns are supported. For example:

  • A pattern for fetching log events that contain a single term.
  • A pattern for fetching log events that contain multiple terms.
  • A pattern for fetching log events that include a term and exclude another.

Note: Filter patterns are case sensitive.

For more information, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html

  • Pattern for fetching log events that contain a single term, "STATUS_CODE":

"STATUS_CODE"

  • Pattern for fetching log events that contain multiple terms, “STATUS_CODE” and “200”:

“STATUS_CODE 200”

  • Pattern for fetching log events that include a term, “STATUS_CODE,” and exclude another term, “200”:

“STATUS_CODE” – “200”

Field

Description

AWS credentials

Field that refers to the AWS Credentials list (aws_credentials.list). The list contains the AWS access and secret access keys.

AWS region

The AWS region where the Amazon CloudWatch cluster runs, for example, us-west-1. For a list of AWS regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions

This field is required.

|Field|Description|Default value| |-----|-----------|-------------| |Connection timeout|The number of milliseconds to wait before timing out the AWS connection attempt.|1000| |Batch size|The maximum number of logs retrieved per query.|2500| |Socket timeout \(ms\)|The number of milliseconds to wait before timing out a data transfer over an established connection.|10000| |Default timezone|The default time zone used when a log doesn't include time zone information.|GMT| |Sub sample drop ratio|The number of logs to batch together, out of which one will be discarded. This setting is used to reduce the number of fetched logs.|-1| |Sub sample receive ratio|The number of logs to batch together, out of which all but one will be discarded. This setting is used to decrease the number of received logs.|-1| |Max length in bytes|The maximum length of log messages, in bytes.|32766| |Character encoding|The character encoding used for this data input. This field is read-only.|UTF-8| |Sleep interval|The interval, in seconds, to wait before querying again after a query has returned no logs.|60| |Polling interval|The interval, in seconds, to wait before polling for new logs.|0| |Drop if queue is full|Option to discard logs if many processes are waiting in the queue to access the MID Server.|Clear|

Parent Topic:Data input configuration fields

Search documentation
Search document titles and file paths on the brazil branch