ELK 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 ELK version also supports other parameters, they can be set in the options parameter.

version#

Installed version.

Required

Datatype

Valid Values

Yes

String

7.11.2
7.12.1
7.13.1
7.14.2
7.15.2
7.16.3
7.17.4
8.0.1
8.1.3
8.2.2

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 -, !, :, ;, %, ', ", ` and \

allow_anonymous#

Enable anonymous access to Kibana.

Required

Datatype

Valid Values

Default

No

Boolean

true
false

false

anonymous_role#

Role for anonymous access.

Required

Datatype

Valid Values

Default

If the parameter is specified allow_anonymous = true

Array of strings

viewer
editor

viewer

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

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 monitoring = true parameter is passed. If monitoring = false, the parameter cannot be passed

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 monitoring = false, the parameter cannot be passed

Yes

Dict

The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters.

options#

Container for other parameters ELK.

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