Parameters for Configuring a System Template

redis: You can import data from a Redis database to an Elasticsearch cluster.

For details, see https://www.elastic.co/guide/en/logstash/7.10/plugins-inputs-redis.html.

**Table 1** Parameter description
Parameter	Mandatory	Description
data_type	Yes	Data source type. The options are list, channel, and pattern_channel. If the parameter is set to list, the BLPOP key is used. If the parameter is set to channel, the SUBSCRIBE key is used. If the parameter is set to pattern_channel, the PSUBSCRIBE key is used.
key	Yes	Redis list or channel name
host	Yes	IP address of the Redis server
port	No	Number of the port to be connected. Default value: 6379.
hosts	Yes	IP address of the node in the Elasticsearch cluster
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.

elasticsearch: You can migrate data between Elasticsearch clusters.

For details, see https://www.elastic.co/guide/en/logstash/7.10/plugins-inputs-elasticsearch.html.

**Table 2** Configuration items
Configuration Item	Mandatory	Description
hosts	Yes	IP address of the node in the Elasticsearch cluster to which data is imported.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index from which data is to be migrated.
docinfo	No	Document information. Value: true or false. If this parameter is specified, add Elasticsearch document information in the event, such as the index, type, and ID.
ca_file	No	The default value is /rds/datastore/logstash/v7.10.0/package/logstash-7.10.0/extend/certs. For Logstash clusters on the cloud, retain the default value or enter the user-defined certificate path if a user-defined certificate is used. For self-built Logstash clusters, you can download the certificate file on the details page of the Elasticsearch cluster with SSL enabled and enter the path here.
ssl	No	Set this parameter to true to enable SSL for the source ES cluster.
hosts	Yes	IP address of the node in the Elasticsearch cluster that outputs data.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.
document_type	No	This parameter is valid only when docinfo is set to true. If docinfo is set to false, delete this parameter from the configuration file.
document_id	No	This parameter is valid only when docinfo is set to true. If docinfo is set to false, delete this parameter from the configuration file.
cacert	No	The default value is /rds/datastore/logstash/v7.10.0/package/logstash-7.10.0/extend/certs. For Logstash clusters on the cloud, retain the default value or enter the user-defined certificate path if a user-defined certificate is used. For self-built Logstash clusters, you can download the certificate file on the details page of the Elasticsearch cluster with SSL enabled and enter the path here.
ssl	No	Set this parameter to true to enable SSL for the destination ES cluster.
ssl_certificate_verification	No	Set this parameter to false to enable SSL and ignore the server certificate verification.

jdbc: You can import data from a Java Database Connectivity (JDBC) to an Elasticsearch cluster.

For details, see https://www.elastic.co/guide/en/logstash/7.10/plugins-inputs-jdbc.html.

**Table 3** Parameter description
Parameter	Mandatory	Description
jdbc_driver_library	Yes	Path of the JDBC driver library. For version 7.10.0, set this field to jdbc_driver_library => "/rds/datastore/logstash/v7.10.0/package/logstash-7.10.0/extend/jars/mariadb-java-client-2.7.0.jar". For version 5.6.16, set this field to jdbc_driver_library => "/rds/datastore/logstash/v5.6.16/package/logstash-5.6.16/extend/jars/mariadb-java-client-2.7.0.jar". Currently, only these existing drivers are supported. User-defined upload is not supported.
jdbc_driver_class	Yes	JDBC driver class to be loaded, for example, "org.mariadb.jdbc.Driver".
jdbc_connection_string	Yes	JDBC connection string
jdbc_user	Yes	JDBC username
jdbc_password	Yes	JDBC password
statement	Yes	SQL statement of the input data.
hosts	Yes	IP address of the node in the Elasticsearch cluster that outputs data.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.

kafka: You can import data from Kafka to an Elasticsearch cluster.

https://www.elastic.co/guide/en/logstash/7.10/plugins-inputs-kafka.html

**Table 4** Parameter description
Parameter	Mandatory	Description
bootstrap_servers	Yes	IP address and port number of the Kafka instance
topics	Yes	List of topics to be subscribed to
group_id	Yes	Identifier of the group to which the consumer belongs.
auto_offset_reset	Yes	Initial offset in Kafka. earliest: Automatically reset the offset to the earliest offset. latest: Automatically reset the offset to the latest offset. none: Report an exception to the consumer if the previous offset for the consumer group is not found. anything else: The system throws an exception to the consumer.
hosts	Yes	IP address of the node in the Elasticsearch cluster that outputs data.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.

dis: You can import data from DIS to an Elasticsearch cluster.

**Table 5** Parameter description
Parameter	Mandatory	Description
streams	Yes	Name of the DIS stream. The entered DIS stream name must be the same as the stream name specified when you are creating a DIS stream on the DIS console.
endpoint	Yes	Data API address of the region where DIS resides.
ak	Yes	User's access key (AK). For details, see Checking Authentication Information.
sk	Yes	User's secret key (SK). For details, see Checking Authentication Information.
region	Yes	Region where DIS is supported.
project_id	Yes	Project ID of the region. For details, see Checking Authentication Information.
group_id	Yes	DIS App name, used to identify a consumer group. The value can be any character string.
client_id	No	Client ID, which identifies a consumer in a consumer group. If multiple pipelines or Logstash instances are started for consumption, set this parameter to different values. For example, the value of instance 1 is client1, and the value of instance 2 is client2.
auto_offset_reset	No	Position where data starts to be consumed from the stream. The options are as follows: earliest: Data is consumed from the earliest one. latest: Data is consumed from the latest one.
hosts	Yes	IP address of the node in the Elasticsearch cluster that outputs data.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.

beats: You can import data from Beats to an Elasticsearch cluster.

https://www.elastic.co/guide/en/logstash/7.10/plugins-inputs-beats.html

**Table 6** Parameter description
Parameter	Mandatory	Description
port	Yes	Listening port number. The port number 5044 is used for connecting and indexing Elasticsearch through Beats.
hosts	Yes	IP address of the node in the Elasticsearch cluster that outputs data.
user	No	Username for logging in to the Elasticsearch cluster. Generally, the value is admin. This parameter is mandatory for a security cluster.
password	No	Password for logging in to the Elasticsearch cluster. The password is set when the cluster is created. This parameter is mandatory for a security cluster.
index	Yes	Index to which the data is to be migrated. Only one index can be configured.