Skip to main content

types

Access​

Access policy for external services.

dataTransfer : bool​

Determines whether the access to Data Transfer is allowed.

serverless : bool​

Determines whether the access to Serverless is allowed.

AnytimeMaintenanceWindow​

An any-time maintenance window.

AuthSettings​

saml : SAMLSettings​

SAML settings

Backup​

id : string​

Required. ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

sourceClusterId : string​

ID of the OpenSearch cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

createdAt : google.protobuf.Timestamp​

Time when the backup operation was completed.

indices : string​

Names of indices in the backup.

opensearchVersion : string​

OpenSearch version used to create the backup.

sizeBytes : int64​

Size of the backup in bytes.

indicesTotal : int64​

The number of indices in the backup.

Cluster​

An OpenSearch cluster resource.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    Health of the cluster is unknown ([Host.health][1] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is working normally ([Host.health][2] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][4] for at least one host in the cluster is not ALIVE).

Status​

Current state of the cluster.

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster has encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster has stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation.

folderId : string​

ID of the folder that the OpenSearch cluster belongs to.

createdAt : google.protobuf.Timestamp​

Time when the cluster was created.

name : string​

Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long.

description : string​

Description of the OpenSearch cluster. 0-256 characters long.

labels : string​

Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource.

environment : Environment​

Deployment environment of the OpenSearch cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the OpenSearch cluster.

config : ClusterConfig​

Configuration of the OpenSearch cluster.

networkId : string​

ID of the cloud network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

securityGroupIds : string​

User security groups.

serviceAccountId : string​

ID of the service account used to access Object Storage.

deletionProtection : bool​

Determines whether the cluster is protected from being deleted.

maintenanceWindow : MaintenanceWindow​

Cluster maintenance window. Should be defined by either one of the two options.

plannedOperation : MaintenanceOperation​

Maintenance operation planned at nearest maintenance_window.

ClusterConfig​

The OpenSearch cluster configuration.

version : string​

Version of the OpenSearch server software.

opensearch : OpenSearch​

OpenSearch configuration.

dashboards : Dashboards​

Dashboards configuration.

access : Access​

Access policy for external services.

Dashboards​

The Dashboards host group type configuration.

NodeGroup​

name : string​

Name of the group. 1-63 characters long.

resources : Resources​

Resources allocated to the hosts.

hostsCount : int64​

Number of hosts in the group.

zoneIds : string​

IDs of the availability zones the hosts belong to.

subnetIds : string​

IDs of the subnets that the hosts belong to.

assignPublicIp : bool​

Determines whether a public IP is assigned to the hosts in the group.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

nodeGroups : NodeGroup​

Host groups of the Dashboards type.

DiskSizeAutoscaling​

plannedUsageThreshold : int64​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : int64​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : int64​

Limit on how large the storage for database instances can automatically grow, in bytes.

Host​

An OpenSearch cluster host resource.

Health​

  • UNKNOWN

    Health of the host is unknown. Default value.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable and cannot perform any of its essential functions.

  • DEGRADED

    The host is working below capacity or not fully functional.

Type​

  • TYPE_UNSPECIFIED

    Type of the host is unspecified. Default value.

  • OPENSEARCH

    An OpenSearch type host.

  • DASHBOARDS

    A Dashboards type host.

CPUMetric​

CPU usage of the host.

timestamp : int64​

Time of the record.

used : double​

Percentage of the CPU used.

MemoryMetric​

RAM usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of RAM used, in bytes.

total : int64​

Total amount of RAM allocated to the host.

DiskMetric​

Disk usage of the host.

timestamp : int64​

Time of the record.

used : int64​

The amount of disk space used, in bytes.

total : int64​

Total amount of disk space allocated to the host.

SystemMetrics​

Resources used by the host.

cpu : CPUMetric​

CPU usage of the host.

memory : MemoryMetric​

RAM usage of the host.

disk : DiskMetric​

Disk usage of the host.

name : string​

Required. Name of the OpenSearch host.

The host name is assigned by the platform at creation time and cannot be changed.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

Required. ID of the OpenSearch cluster. The ID is assigned by the platform at creation time.

zoneId : string​

ID of the availability zone the OpenSearch host belongs to.

resources : Resources​

Resources allocated to the OpenSearch host.

type : Type​

Type of the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Determines whether a public IP is assigned to the host.

system : SystemMetrics​

Resources used by the host.

nodeGroup : string​

Name of the host group that the host belongs to.

roles : OpenSearch.GroupRole​

Roles of the host.

MaintenanceOperation​

info : string​

The description of the operation.

delayedUntil : google.protobuf.Timestamp​

Delay time for the maintenance operation.

latestMaintenanceTime : google.protobuf.Timestamp​

Time of the last maintenance window.

nextMaintenanceWindowTime : google.protobuf.Timestamp​

Time of the next maintenance window.

MaintenanceWindow​

An OpenSearch cluster maintenance window. Should be defined by either one of the two options.

One of policy​

  • anytime : AnytimeMaintenanceWindow​

    An any-time maintenance window.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    A weekly maintenance window.

Monitoring​

Monitoring system metadata.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the OpenSearch cluster.

OpenSearch​

The OpenSearch host group type configuration.

GroupRole​

  • GROUP_ROLE_UNSPECIFIED

  • DATA

  • MANAGER

NodeGroup​

Configuration of the host group.

name : string​

Name of the group. Must be 1-63 characters long.

resources : Resources​

Resources allocated to the hosts.

hostsCount : int64​

Number of hosts in the group.

zoneIds : string​

IDs of the availability zones the hosts belong to.

subnetIds : string​

IDs of the subnets that the hosts belong to.

assignPublicIp : bool​

Determines whether a public IP is assigned to the hosts in the group.

roles : GroupRole​

Roles of the host group.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

plugins : string​

Names of the cluster plugins.

nodeGroups : NodeGroup​

Host groups of the OpenSearch type.

One of config​

  • opensearchConfigSet_2 : config.OpenSearchConfigSet2​
keystoreSettings : string​

Keystore entries names.

ResourcePreset​

A preset of resources for hardware configuration of the OpenSearch hosts.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of the availability zones where the resource preset is available.

cores : int64​

Number of the CPU cores for an OpenSearch host created with the preset.

memory : int64​

RAM volume for an OpenSearch host created with the preset, in bytes.

Resources​

A list of computational resources allocated to a host.

resourcePresetId : string​

ID of the preset for computational resources allocated to a host.

diskSize : int64​

Volume of the storage used by the host, in bytes.

diskTypeId : string​

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

SAMLSettings​

enabled : bool​
idpEntityId : string​

Required. The entity ID of your IdP.

idpMetadataFile : bytes​

Required. The SAML 2.0 metadata file of your IdP.

spEntityId : string​

Required. The entity ID of the service provider.

dashboardsUrl : string​

Required. The OpenSearch Dashboards base URL.

rolesKey : string​

Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used.

subjectKey : string​

Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used.

jwtDefaultExpirationTimeout : google.protobuf.Int64Value​

default jwt expiration timeout.

WeeklyMaintenanceWindow​

A weekly maintenance window.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

    Monday

  • TUE

    Tuesday

  • WED

    Wednesday

  • THU

    Thursday

  • FRI

    Friday

  • SAT

    Saturday

  • SUN

    Sunday

day : WeekDay​

Day of the week.

hour : int64​

Hour of the day in the UTC timezone.