Elasticsearch parameters
In this article:
Elasticsearch parameters#
Parameters for creating a service#
These parameters are provided as parameters in the method CreateService.
When creating a new service, the parameters marked as Required should be provided.
If the selected version Elasticsearch supports other parameters, they can be set in the options parameter.
version#
Installed version.
Required |
Datatype |
Valid Values |
---|---|---|
Yes |
String |
7.11 |
password#
Elasticsearch user password. If a password is set, authentication is required to log in to Kibana.
Required |
Datatype |
Valid Values |
---|---|---|
No |
String |
The string should be 8 to 128 characters and should not contain |
kibana#
Indicates whether Kibana will be deployed as well.
Required |
Datatype |
Valid Values |
---|---|---|
No |
Boolean |
true |
monitoring - The monitoring information for the instance#
Connection to a monitoring service.
Required |
Editable |
Datatype |
Valid Values |
Default |
---|---|---|---|---|
For all services, except for Prometheus |
Yes |
Boolean |
true |
false |
monitor_by#
Monitoring service ID. The specified service must be deployed in the same project as the current service.
Required |
Editable |
Datatype |
Valid Values |
---|---|---|---|
Yes, if the |
Yes |
String |
The ID of a monitoring service running within the same VPC as the current service |
monitoring_labels#
Labels to be assigned to the metrics of the monitored service in the monitoring service.
Required |
Editable |
Datatype |
Valid Values |
---|---|---|---|
No. If |
Yes |
Dict |
The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters. |
logging#
Connection to a logging service.
Required |
Editable |
Datatype |
Valid Values |
Default |
---|---|---|---|---|
For all services, except for ELK and Prometheus |
Yes |
Boolean |
true |
false |
log_to#
Logging service ID. The logged service must be deployed in the same project as the current service.
Required |
Editable |
Datatype |
Valid Values |
Default |
---|---|---|---|---|
Yes, if the |
Yes |
String |
The ID of a monitoring service running within the same VPC as the current service |
options#
Container for other parameters Elasticsearch.
Note
If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.
Required |
Datatype |
Valid Values |
---|---|---|
No |
Dict |
N/A |