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

Parameters for creating and editing the snapshot repository#

These parameters are specified as parameters in the CreateElasticsearchSnapshotRepository method. When adding the snapshot repository, be sure to specify all parameters marked as Required. The Enabled parameter should always be set to false, as the snapshot repository can only be disconnected when being added. To make the snapshot repository available in the service, connect it explicitly using the EnableElasticsearchSnapshotRepository method.

To disconnect the snapshot repository, use the DisableElasticsearchSnapshotRepository method. After that, the repository will no longer be available in the service.

You can delete the snapshot repository with the DeleteElasticsearchSnapshotRepository method. Disconnect it before deleting. If you attempt to delete a connected snapshot repository, an error message will be displayed, while the snapshot repository will not be deleted.

If the fromExistingService parameter is set to false, a new snapshot repository will be created. To do this, specify the bucketName, userLogin and directoryName parameters.

If the fromExistingService parameter is set to true, an existing snapshot repository will be added. To do this, in the recoveryServiceId parameter specify the ID of an Elasticsearch or ELK service, to which this repository is connected. The service versions should be compatible with each other so that the data can be recovered from the snapshots. The snapshot repository of an existing service will be added as a read-only repository, which can only be used to recover data from the snapshot.

A version compatibility table can be found in the official Elasticsearch documentation.

Use the ListElasticsearchServicesSuitableForRecovery method to get the list of the running Elasticsearch or ELK services that can be used for recovery of the target service.

Use the ListElasticsearchSnapshotRepository method to get information about the repository connected to the service.

enabled#

Indicates whether the snapshot repository is connected.

Required

Editable

Datatype

Valid values

Yes

Yes

Boolean

true
false

fromExistingService#

Indicates whether a new repository is created or the repository of an existing Elasticsearch or ELK service is added.

Required

Editable

Datatype

Valid values

Yes

No

Boolean

true
false

bucketName#

The bucket name in the object storage. The parameter is only applicable and required when fromExistingService is false.

Required

Editable

Datatype

Valid values

No

No

String

The name of an existing bucket in the object storage, which the user can access.

userLogin#

Login of a user who has rights to write into the object storage bucket. The parameter is only applicable and required when fromExistingService is false.

Required

Editable

Datatype

Valid values

No

No

String

The name of an existing user who has rights to write into the object storage bucket.

directoryName#

The name of a directory in the object storage. The parameter is only applicable and required when fromExistingService is false.

Required

Editable

Datatype

Valid values

No

No

String

Valid directory name.

recoveryServiceId#

The ID of the existing Elasticsearch or ELK service, from whose storage data has to be recovered. This parameter is only applicable and required when fromExistingService is true.

Required

Editable

Datatype

Valid values

No

No

String

The ID of an existing Elasticsearch or ELK service, from whose storage data has to be recovered.