Aiven v6.37.0, Apr 10 25

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.getOpenSearch

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const os1 = aiven.getOpenSearch({
    project: pr1.project,
    serviceName: "my-os1",
});

import pulumi
import pulumi_aiven as aiven

os1 = aiven.get_open_search(project=pr1["project"],
    service_name="my-os1")

package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupOpenSearch(ctx, &aiven.LookupOpenSearchArgs{
			Project:     pr1.Project,
			ServiceName: "my-os1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var os1 = Aiven.GetOpenSearch.Invoke(new()
    {
        Project = pr1.Project,
        ServiceName = "my-os1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetOpenSearchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var os1 = AivenFunctions.getOpenSearch(GetOpenSearchArgs.builder()
            .project(pr1.project())
            .serviceName("my-os1")
            .build());

    }
}

variables:
  os1:
    fn::invoke:
      function: aiven:getOpenSearch
      arguments:
        project: ${pr1.project}
        serviceName: my-os1

Using getOpenSearch

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOpenSearch(args: GetOpenSearchArgs, opts?: InvokeOptions): Promise<GetOpenSearchResult>
function getOpenSearchOutput(args: GetOpenSearchOutputArgs, opts?: InvokeOptions): Output<GetOpenSearchResult>

def get_open_search(project: Optional[str] = None,
                    service_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetOpenSearchResult
def get_open_search_output(project: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetOpenSearchResult]

func LookupOpenSearch(ctx *Context, args *LookupOpenSearchArgs, opts ...InvokeOption) (*LookupOpenSearchResult, error)
func LookupOpenSearchOutput(ctx *Context, args *LookupOpenSearchOutputArgs, opts ...InvokeOption) LookupOpenSearchResultOutput

> Note: This function is named LookupOpenSearch in the Go SDK.

public static class GetOpenSearch 
{
    public static Task<GetOpenSearchResult> InvokeAsync(GetOpenSearchArgs args, InvokeOptions? opts = null)
    public static Output<GetOpenSearchResult> Invoke(GetOpenSearchInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOpenSearchResult> getOpenSearch(GetOpenSearchArgs args, InvokeOptions options)
public static Output<GetOpenSearchResult> getOpenSearch(GetOpenSearchArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getOpenSearch:getOpenSearch
  arguments:
    # arguments dictionary

The following arguments are supported:

Project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

Project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project String: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project str: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name str: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project String: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

getOpenSearch Result

The following output properties are available:

AdditionalDiskSpace string: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<GetOpenSearchComponent>: Service component information objects
DiskSpace string: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string: Disk space that service is currently using
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
OpensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Opensearches List<GetOpenSearchOpensearch>: OpenSearch server provided values
Plan string: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string: The hostname of the service.
ServiceIntegrations List<GetOpenSearchServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string: Password used for connecting to the service, if applicable
ServicePort int: The port of the service
ServiceType string: Aiven internal service type code
ServiceUri string: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string: Username used for connecting to the service, if applicable
State string
StaticIps List<string>: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<GetOpenSearchTag>: Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetOpenSearchTechEmail>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

AdditionalDiskSpace string: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []GetOpenSearchComponent: Service component information objects
DiskSpace string: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string: Disk space that service is currently using
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
OpensearchUserConfigs []GetOpenSearchOpensearchUserConfig: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Opensearches []GetOpenSearchOpensearch: OpenSearch server provided values
Plan string: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ProjectVpcId string: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string: The hostname of the service.
ServiceIntegrations []GetOpenSearchServiceIntegration: Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string: Password used for connecting to the service, if applicable
ServicePort int: The port of the service
ServiceType string: Aiven internal service type code
ServiceUri string: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string: Username used for connecting to the service, if applicable
State string
StaticIps []string: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []GetOpenSearchTag: Tags are key-value pairs that allow you to categorize services.
TechEmails []GetOpenSearchTechEmail: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace String: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<GetOpenSearchComponent>: Service component information objects
diskSpace String: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String: Disk space that service is currently using
id String: The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
opensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
opensearches List<GetOpenSearchOpensearch>: OpenSearch server provided values
plan String: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project String: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String: The hostname of the service.
serviceIntegrations List<GetOpenSearchServiceIntegration>: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String: Password used for connecting to the service, if applicable
servicePort Integer: The port of the service
serviceType String: Aiven internal service type code
serviceUri String: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String: Username used for connecting to the service, if applicable
state String
staticIps List<String>: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<GetOpenSearchTag>: Tags are key-value pairs that allow you to categorize services.
techEmails List<GetOpenSearchTechEmail>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace string: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components GetOpenSearchComponent[]: Service component information objects
diskSpace string: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap string: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string: Disk space that service is currently using
id string: The provider-assigned unique ID for this managed resource.
maintenanceWindowDow string: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
opensearchUserConfigs GetOpenSearchOpensearchUserConfig[]: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
opensearches GetOpenSearchOpensearch[]: OpenSearch server provided values
plan string: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId string: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string: The hostname of the service.
serviceIntegrations GetOpenSearchServiceIntegration[]: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName string: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string: Password used for connecting to the service, if applicable
servicePort number: The port of the service
serviceType string: Aiven internal service type code
serviceUri string: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string: Username used for connecting to the service, if applicable
state string
staticIps string[]: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags GetOpenSearchTag[]: Tags are key-value pairs that allow you to categorize services.
techEmails GetOpenSearchTechEmail[]: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additional_disk_space str: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[GetOpenSearchComponent]: Service component information objects
disk_space str: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
disk_space_cap str: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str: Disk space that service is currently using
id str: The provider-assigned unique ID for this managed resource.
maintenance_window_dow str: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
opensearch_user_configs Sequence[GetOpenSearchOpensearchUserConfig]: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
opensearches Sequence[GetOpenSearchOpensearch]: OpenSearch server provided values
plan str: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project str: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project_vpc_id str: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str: The hostname of the service.
service_integrations Sequence[GetOpenSearchServiceIntegration]: Service integrations to specify when creating a service. Not applied after initial service creation
service_name str: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str: Password used for connecting to the service, if applicable
service_port int: The port of the service
service_type str: Aiven internal service type code
service_uri str: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str: Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[GetOpenSearchTag]: Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetOpenSearchTechEmail]: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace String: Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>: Service component information objects
diskSpace String: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String: Disk space that service is currently using
id String: The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String: Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String: Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
opensearchUserConfigs List<Property Map>: Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
opensearches List<Property Map>: OpenSearch server provided values
plan String: Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project String: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
projectVpcId String: Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String: The hostname of the service.
serviceIntegrations List<Property Map>: Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String: Password used for connecting to the service, if applicable
servicePort Number: The port of the service
serviceType String: Aiven internal service type code
serviceUri String: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String: Username used for connecting to the service, if applicable
state String
staticIps List<String>: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>: Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

GetOpenSearchComponent

Component string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string: DNS usage name

Component string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
port Integer: Port number for connecting to the service component
route String: Network access route
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String: DNS usage name

component string: Service component name
connectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
host string: Host name for connecting to the service component
kafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
port number: Port number for connecting to the service component
route string: Network access route
ssl boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage string: DNS usage name

component str: Service component name
connection_uri str: Connection info for connecting to the service component. This is a combination of host and port.
host str: Host name for connecting to the service component
kafka_authentication_method str: Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str: Kafka certificate used. The possible values are letsencrypt and project_ca.
port int: Port number for connecting to the service component
route str: Network access route
ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage str: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
port Number: Port number for connecting to the service component
route String: Network access route
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String: DNS usage name

GetOpenSearchOpensearch

KibanaUri string: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
OpensearchDashboardsUri string: URI for OpenSearch dashboard frontend
Password string: OpenSearch password
Uris List<string>: OpenSearch server URIs.
Username string: OpenSearch username

KibanaUri string: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
OpensearchDashboardsUri string: URI for OpenSearch dashboard frontend
Password string: OpenSearch password
Uris []string: OpenSearch server URIs.
Username string: OpenSearch username

kibanaUri String: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
opensearchDashboardsUri String: URI for OpenSearch dashboard frontend
password String: OpenSearch password
uris List<String>: OpenSearch server URIs.
username String: OpenSearch username

kibanaUri string: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
opensearchDashboardsUri string: URI for OpenSearch dashboard frontend
password string: OpenSearch password
uris string[]: OpenSearch server URIs.
username string: OpenSearch username

kibana_uri str: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
opensearch_dashboards_uri str: URI for OpenSearch dashboard frontend
password str: OpenSearch password
uris Sequence[str]: OpenSearch server URIs.
username str: OpenSearch username

kibanaUri String: URI for Kibana dashboard frontend
Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.
opensearchDashboardsUri String: URI for OpenSearch dashboard frontend
password String: OpenSearch password
uris List<String>: OpenSearch server URIs.
username String: OpenSearch username

GetOpenSearchOpensearchUserConfig

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
AzureMigration GetOpenSearchOpensearchUserConfigAzureMigration: Azure migration settings
CustomDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
DisableReplicationFactorAdjustment bool: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
GcsMigration GetOpenSearchOpensearchUserConfigGcsMigration: Google Cloud Storage migration settings
IndexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>: Index patterns
IndexRollup GetOpenSearchOpensearchUserConfigIndexRollup: Index rollup settings
IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate: Template settings for all new indexes
IpFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
KeepIndexRefreshInterval bool: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
MaxIndexCount int: Use index_patterns instead. Default: 0.
Openid GetOpenSearchOpensearchUserConfigOpenid: OpenSearch OpenID Connect Configuration
Opensearch GetOpenSearchOpensearchUserConfigOpensearch: OpenSearch settings
OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards: OpenSearch Dashboards settings
OpensearchVersion string: Enum: 1, 2, and newer. OpenSearch major version.
PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess: Allow access to selected service ports from the public Internet
RecoveryBasebackupName string: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
S3Migration GetOpenSearchOpensearchUserConfigS3Migration: AWS S3 / AWS S3 compatible migration settings
Saml GetOpenSearchOpensearchUserConfigSaml: OpenSearch SAML configuration
ServiceLog bool: Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
StaticIps bool: Use static public IP addresses.

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
AzureMigration GetOpenSearchOpensearchUserConfigAzureMigration: Azure migration settings
CustomDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
DisableReplicationFactorAdjustment bool: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
GcsMigration GetOpenSearchOpensearchUserConfigGcsMigration: Google Cloud Storage migration settings
IndexPatterns []GetOpenSearchOpensearchUserConfigIndexPattern: Index patterns
IndexRollup GetOpenSearchOpensearchUserConfigIndexRollup: Index rollup settings
IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate: Template settings for all new indexes
IpFilterObjects []GetOpenSearchOpensearchUserConfigIpFilterObject: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
KeepIndexRefreshInterval bool: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
MaxIndexCount int: Use index_patterns instead. Default: 0.
Openid GetOpenSearchOpensearchUserConfigOpenid: OpenSearch OpenID Connect Configuration
Opensearch GetOpenSearchOpensearchUserConfigOpensearch: OpenSearch settings
OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards: OpenSearch Dashboards settings
OpensearchVersion string: Enum: 1, 2, and newer. OpenSearch major version.
PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess: Allow access to selected service ports from private networks
PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess: Allow access to selected service ports from the public Internet
RecoveryBasebackupName string: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
S3Migration GetOpenSearchOpensearchUserConfigS3Migration: AWS S3 / AWS S3 compatible migration settings
Saml GetOpenSearchOpensearchUserConfigSaml: OpenSearch SAML configuration
ServiceLog bool: Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
StaticIps bool: Use static public IP addresses.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
azureMigration GetOpenSearchOpensearchUserConfigAzureMigration: Azure migration settings
customDomain String: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
disableReplicationFactorAdjustment Boolean: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
gcsMigration GetOpenSearchOpensearchUserConfigGcsMigration: Google Cloud Storage migration settings
indexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>: Index patterns
indexRollup GetOpenSearchOpensearchUserConfigIndexRollup: Index rollup settings
indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate: Template settings for all new indexes
ipFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
keepIndexRefreshInterval Boolean: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
maxIndexCount Integer: Use index_patterns instead. Default: 0.
openid GetOpenSearchOpensearchUserConfigOpenid: OpenSearch OpenID Connect Configuration
opensearch GetOpenSearchOpensearchUserConfigOpensearch: OpenSearch settings
opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards: OpenSearch Dashboards settings
opensearchVersion String: Enum: 1, 2, and newer. OpenSearch major version.
privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetOpenSearchOpensearchUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recoveryBasebackupName String: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
s3Migration GetOpenSearchOpensearchUserConfigS3Migration: AWS S3 / AWS S3 compatible migration settings
saml GetOpenSearchOpensearchUserConfigSaml: OpenSearch SAML configuration
serviceLog Boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps Boolean: Use static public IP addresses.

additionalBackupRegions string: Additional Cloud Regions for Backup Replication.
azureMigration GetOpenSearchOpensearchUserConfigAzureMigration: Azure migration settings
customDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
disableReplicationFactorAdjustment boolean: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
gcsMigration GetOpenSearchOpensearchUserConfigGcsMigration: Google Cloud Storage migration settings
indexPatterns GetOpenSearchOpensearchUserConfigIndexPattern[]: Index patterns
indexRollup GetOpenSearchOpensearchUserConfigIndexRollup: Index rollup settings
indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate: Template settings for all new indexes
ipFilterObjects GetOpenSearchOpensearchUserConfigIpFilterObject[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
keepIndexRefreshInterval boolean: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
maxIndexCount number: Use index_patterns instead. Default: 0.
openid GetOpenSearchOpensearchUserConfigOpenid: OpenSearch OpenID Connect Configuration
opensearch GetOpenSearchOpensearchUserConfigOpensearch: OpenSearch settings
opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards: OpenSearch Dashboards settings
opensearchVersion string: Enum: 1, 2, and newer. OpenSearch major version.
privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
projectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetOpenSearchOpensearchUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recoveryBasebackupName string: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
s3Migration GetOpenSearchOpensearchUserConfigS3Migration: AWS S3 / AWS S3 compatible migration settings
saml GetOpenSearchOpensearchUserConfigSaml: OpenSearch SAML configuration
serviceLog boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps boolean: Use static public IP addresses.

additional_backup_regions str: Additional Cloud Regions for Backup Replication.
azure_migration GetOpenSearchOpensearchUserConfigAzureMigration: Azure migration settings
custom_domain str: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
disable_replication_factor_adjustment bool: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
gcs_migration GetOpenSearchOpensearchUserConfigGcsMigration: Google Cloud Storage migration settings
index_patterns Sequence[GetOpenSearchOpensearchUserConfigIndexPattern]: Index patterns
index_rollup GetOpenSearchOpensearchUserConfigIndexRollup: Index rollup settings
index_template GetOpenSearchOpensearchUserConfigIndexTemplate: Template settings for all new indexes
ip_filter_objects Sequence[GetOpenSearchOpensearchUserConfigIpFilterObject]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
keep_index_refresh_interval bool: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
max_index_count int: Use index_patterns instead. Default: 0.
openid GetOpenSearchOpensearchUserConfigOpenid: OpenSearch OpenID Connect Configuration
opensearch GetOpenSearchOpensearchUserConfigOpensearch: OpenSearch settings
opensearch_dashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards: OpenSearch Dashboards settings
opensearch_version str: Enum: 1, 2, and newer. OpenSearch major version.
private_access GetOpenSearchOpensearchUserConfigPrivateAccess: Allow access to selected service ports from private networks
privatelink_access GetOpenSearchOpensearchUserConfigPrivatelinkAccess: Allow access to selected service components through Privatelink
project_to_fork_from str: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
public_access GetOpenSearchOpensearchUserConfigPublicAccess: Allow access to selected service ports from the public Internet
recovery_basebackup_name str: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
s3_migration GetOpenSearchOpensearchUserConfigS3Migration: AWS S3 / AWS S3 compatible migration settings
saml GetOpenSearchOpensearchUserConfigSaml: OpenSearch SAML configuration
service_log bool: Store logs for the service so that they are available in the HTTP API and console.
service_to_fork_from str: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
static_ips bool: Use static public IP addresses.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
azureMigration Property Map: Azure migration settings
customDomain String: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
disableReplicationFactorAdjustment Boolean: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
gcsMigration Property Map: Google Cloud Storage migration settings
indexPatterns List<Property Map>: Index patterns
indexRollup Property Map: Index rollup settings
indexTemplate Property Map: Template settings for all new indexes
ipFilterObjects List<Property Map>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
keepIndexRefreshInterval Boolean: Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.
maxIndexCount Number: Use index_patterns instead. Default: 0.
openid Property Map: OpenSearch OpenID Connect Configuration
opensearch Property Map: OpenSearch settings
opensearchDashboards Property Map: OpenSearch Dashboards settings
opensearchVersion String: Enum: 1, 2, and newer. OpenSearch major version.
privateAccess Property Map: Allow access to selected service ports from private networks
privatelinkAccess Property Map: Allow access to selected service components through Privatelink
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess Property Map: Allow access to selected service ports from the public Internet
recoveryBasebackupName String: Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
s3Migration Property Map: AWS S3 / AWS S3 compatible migration settings
saml Property Map: OpenSearch SAML configuration
serviceLog Boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
staticIps Boolean: Use static public IP addresses.

GetOpenSearchOpensearchUserConfigAzureMigration

Account string: Account name.
BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Container string: Azure container name.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
EndpointSuffix string: Defines the DNS suffix for Azure Storage endpoints.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Key string: Azure account secret key. One of key or sas_token should be specified.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.
SasToken string: A shared access signatures (SAS) token. One of key or sas_token should be specified.

Account string: Account name.
BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Container string: Azure container name.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
EndpointSuffix string: Defines the DNS suffix for Azure Storage endpoints.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Key string: Azure account secret key. One of key or sas_token should be specified.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.
SasToken string: A shared access signatures (SAS) token. One of key or sas_token should be specified.

account String: Account name.
basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
container String: Azure container name.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
endpointSuffix String: Defines the DNS suffix for Azure Storage endpoints.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
key String: Azure account secret key. One of key or sas_token should be specified.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.
sasToken String: A shared access signatures (SAS) token. One of key or sas_token should be specified.

account string: Account name.
basePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
container string: Azure container name.
indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName string: The snapshot name to restore from.
chunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress boolean: When set to true metadata files are stored in compressed format.
endpointSuffix string: Defines the DNS suffix for Azure Storage endpoints.
includeAliases boolean: Whether to restore aliases alongside their associated indexes. Default is true.
key string: Azure account secret key. One of key or sas_token should be specified.
readonly boolean: Whether the repository is read-only. Default: true.
restoreGlobalState boolean: If true, restore the cluster state. Defaults to false.
sasToken string: A shared access signatures (SAS) token. One of key or sas_token should be specified.

account str: Account name.
base_path str: The path to the repository data within its container. The value of this setting should not start or end with a /.
container str: Azure container name.
indices str: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshot_name str: The snapshot name to restore from.
chunk_size str: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress bool: When set to true metadata files are stored in compressed format.
endpoint_suffix str: Defines the DNS suffix for Azure Storage endpoints.
include_aliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
key str: Azure account secret key. One of key or sas_token should be specified.
readonly bool: Whether the repository is read-only. Default: true.
restore_global_state bool: If true, restore the cluster state. Defaults to false.
sas_token str: A shared access signatures (SAS) token. One of key or sas_token should be specified.

account String: Account name.
basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
container String: Azure container name.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
endpointSuffix String: Defines the DNS suffix for Azure Storage endpoints.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
key String: Azure account secret key. One of key or sas_token should be specified.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.
sasToken String: A shared access signatures (SAS) token. One of key or sas_token should be specified.

GetOpenSearchOpensearchUserConfigGcsMigration

BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Bucket string: The path to the repository data within its container.
Credentials string: Google Cloud Storage credentials file content.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.

BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Bucket string: The path to the repository data within its container.
Credentials string: Google Cloud Storage credentials file content.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.

basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket String: The path to the repository data within its container.
credentials String: Google Cloud Storage credentials file content.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.

basePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket string: The path to the repository data within its container.
credentials string: Google Cloud Storage credentials file content.
indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName string: The snapshot name to restore from.
chunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress boolean: When set to true metadata files are stored in compressed format.
includeAliases boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly boolean: Whether the repository is read-only. Default: true.
restoreGlobalState boolean: If true, restore the cluster state. Defaults to false.

base_path str: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket str: The path to the repository data within its container.
credentials str: Google Cloud Storage credentials file content.
indices str: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshot_name str: The snapshot name to restore from.
chunk_size str: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress bool: When set to true metadata files are stored in compressed format.
include_aliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
readonly bool: Whether the repository is read-only. Default: true.
restore_global_state bool: If true, restore the cluster state. Defaults to false.

basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket String: The path to the repository data within its container.
credentials String: Google Cloud Storage credentials file content.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.

GetOpenSearchOpensearchUserConfigIndexPattern

MaxIndexCount int: Maximum number of indexes to keep. Example: 3.
Pattern string: fnmatch pattern. Example: logs_*_foo_*.
SortingAlgorithm string: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

MaxIndexCount int: Maximum number of indexes to keep. Example: 3.
Pattern string: fnmatch pattern. Example: logs_*_foo_*.
SortingAlgorithm string: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount Integer: Maximum number of indexes to keep. Example: 3.
pattern String: fnmatch pattern. Example: logs_*_foo_*.
sortingAlgorithm String: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount number: Maximum number of indexes to keep. Example: 3.
pattern string: fnmatch pattern. Example: logs_*_foo_*.
sortingAlgorithm string: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

max_index_count int: Maximum number of indexes to keep. Example: 3.
pattern str: fnmatch pattern. Example: logs_*_foo_*.
sorting_algorithm str: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount Number: Maximum number of indexes to keep. Example: 3.
pattern String: fnmatch pattern. Example: logs_*_foo_*.
sortingAlgorithm String: Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

GetOpenSearchOpensearchUserConfigIndexRollup

RollupDashboardsEnabled bool: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
RollupEnabled bool: Whether the rollup plugin is enabled. Defaults to true.
RollupSearchBackoffCount int: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
RollupSearchBackoffMillis int: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
RollupSearchSearchAllJobs bool: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

RollupDashboardsEnabled bool: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
RollupEnabled bool: Whether the rollup plugin is enabled. Defaults to true.
RollupSearchBackoffCount int: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
RollupSearchBackoffMillis int: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
RollupSearchSearchAllJobs bool: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled Boolean: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
rollupEnabled Boolean: Whether the rollup plugin is enabled. Defaults to true.
rollupSearchBackoffCount Integer: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
rollupSearchBackoffMillis Integer: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
rollupSearchSearchAllJobs Boolean: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled boolean: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
rollupEnabled boolean: Whether the rollup plugin is enabled. Defaults to true.
rollupSearchBackoffCount number: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
rollupSearchBackoffMillis number: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
rollupSearchSearchAllJobs boolean: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollup_dashboards_enabled bool: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
rollup_enabled bool: Whether the rollup plugin is enabled. Defaults to true.
rollup_search_backoff_count int: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
rollup_search_backoff_millis int: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
rollup_search_search_all_jobs bool: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled Boolean: Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
rollupEnabled Boolean: Whether the rollup plugin is enabled. Defaults to true.
rollupSearchBackoffCount Number: How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
rollupSearchBackoffMillis Number: The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
rollupSearchSearchAllJobs Boolean: Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

GetOpenSearchOpensearchUserConfigIndexTemplate

MappingNestedObjectsLimit int: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
NumberOfReplicas int: The number of replicas each primary shard has. Example: 1.
NumberOfShards int: The number of primary shards that an index should have. Example: 1.

MappingNestedObjectsLimit int: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
NumberOfReplicas int: The number of replicas each primary shard has. Example: 1.
NumberOfShards int: The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit Integer: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
numberOfReplicas Integer: The number of replicas each primary shard has. Example: 1.
numberOfShards Integer: The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit number: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
numberOfReplicas number: The number of replicas each primary shard has. Example: 1.
numberOfShards number: The number of primary shards that an index should have. Example: 1.

mapping_nested_objects_limit int: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
number_of_replicas int: The number of replicas each primary shard has. Example: 1.
number_of_shards int: The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit Number: The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.
numberOfReplicas Number: The number of replicas each primary shard has. Example: 1.
numberOfShards Number: The number of primary shards that an index should have. Example: 1.

GetOpenSearchOpensearchUserConfigIpFilterObject

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

network string: CIDR address block. Example: 10.20.0.0/16.
description string: Description for IP filter list entry. Example: Production service IP range.

network str: CIDR address block. Example: 10.20.0.0/16.
description str: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

GetOpenSearchOpensearchUserConfigOpenid

ClientId string: The ID of the OpenID Connect client configured in your IdP. Required.
ClientSecret string: The client secret of the OpenID Connect client configured in your IdP. Required.
ConnectUrl string: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
Enabled bool: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
Header string: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
JwtHeader string: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
JwtUrlParameter string: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
RefreshRateLimitCount int: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
RefreshRateLimitTimeWindowMs int: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
RolesKey string: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
Scope string: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
SubjectKey string: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

ClientId string: The ID of the OpenID Connect client configured in your IdP. Required.
ClientSecret string: The client secret of the OpenID Connect client configured in your IdP. Required.
ConnectUrl string: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
Enabled bool: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
Header string: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
JwtHeader string: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
JwtUrlParameter string: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
RefreshRateLimitCount int: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
RefreshRateLimitTimeWindowMs int: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
RolesKey string: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
Scope string: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
SubjectKey string: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId String: The ID of the OpenID Connect client configured in your IdP. Required.
clientSecret String: The client secret of the OpenID Connect client configured in your IdP. Required.
connectUrl String: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
enabled Boolean: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
header String: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
jwtHeader String: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
jwtUrlParameter String: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
refreshRateLimitCount Integer: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
refreshRateLimitTimeWindowMs Integer: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
rolesKey String: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
scope String: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
subjectKey String: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId string: The ID of the OpenID Connect client configured in your IdP. Required.
clientSecret string: The client secret of the OpenID Connect client configured in your IdP. Required.
connectUrl string: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
enabled boolean: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
header string: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
jwtHeader string: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
jwtUrlParameter string: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
refreshRateLimitCount number: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
refreshRateLimitTimeWindowMs number: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
rolesKey string: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
scope string: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
subjectKey string: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

client_id str: The ID of the OpenID Connect client configured in your IdP. Required.
client_secret str: The client secret of the OpenID Connect client configured in your IdP. Required.
connect_url str: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
enabled bool: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
header str: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
jwt_header str: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
jwt_url_parameter str: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
refresh_rate_limit_count int: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
refresh_rate_limit_time_window_ms int: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
roles_key str: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
scope str: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
subject_key str: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId String: The ID of the OpenID Connect client configured in your IdP. Required.
clientSecret String: The client secret of the OpenID Connect client configured in your IdP. Required.
connectUrl String: The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
enabled Boolean: Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.
header String: HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.
jwtHeader String: The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.
jwtUrlParameter String: If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.
refreshRateLimitCount Number: The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.
refreshRateLimitTimeWindowMs Number: The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.
rolesKey String: The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.
scope String: The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
subjectKey String: The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

GetOpenSearchOpensearchUserConfigOpensearch

ActionAutoCreateIndexEnabled bool: Explicitly allow or block automatic creation of indices. Defaults to true.
ActionDestructiveRequiresName bool: Require explicit index names when deleting.
AuthFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners: Opensearch Security Plugin Settings
ClusterMaxShardsPerNode int: Controls the number of shards allowed in the cluster per data node. Example: 1000.
ClusterRoutingAllocationBalancePreferPrimary bool: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
ClusterRoutingAllocationNodeConcurrentRecoveries int: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
ClusterSearchRequestSlowlog GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog
DiskWatermarks GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks: Watermark settings
EmailSenderName string: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
EmailSenderPassword string: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
EmailSenderUsername string: Sender username for Opensearch alerts. Example: jane@example.com.
EnableRemoteBackedStorage bool: Enable remote-backed storage.
EnableSecurityAudit bool: Enable/Disable security audit.
HttpMaxContentLength int: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
HttpMaxHeaderSize int: The max size of allowed headers, in bytes. Example: 8192.
HttpMaxInitialLineLength int: The max length of an HTTP URL, in bytes. Example: 4096.
IndicesFielddataCacheSize int: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
IndicesMemoryIndexBufferSize int: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
IndicesMemoryMaxIndexBufferSize int: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
IndicesMemoryMinIndexBufferSize int: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
IndicesQueriesCacheSize int: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
IndicesQueryBoolMaxClauseCount int: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
IndicesRecoveryMaxBytesPerSec int: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
IndicesRecoveryMaxConcurrentFileChunks int: Number of file chunks sent in parallel for each recovery. Defaults to 2.
IsmEnabled bool: Specifies whether ISM is enabled or not.
IsmHistoryEnabled bool: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
IsmHistoryMaxAge int: The maximum age before rolling over the audit history index in hours. Example: 24.
IsmHistoryMaxDocs int: The maximum number of documents before rolling over the audit history index. Example: 2500000.
IsmHistoryRolloverCheckPeriod int: The time between rollover checks for the audit history index in hours. Example: 8.
IsmHistoryRolloverRetentionPeriod int: How long audit history indices are kept in days. Example: 30.
KnnMemoryCircuitBreakerEnabled bool: Enable or disable KNN memory circuit breaker. Defaults to true.
KnnMemoryCircuitBreakerLimit int: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
OverrideMainResponseVersion bool: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
PluginsAlertingFilterByBackendRoles bool: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
ReindexRemoteWhitelists List<string>: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
ScriptMaxCompilationsRate string: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
SearchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure: Search Backpressure Settings
SearchInsightsTopQueries GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries
SearchMaxBuckets int: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
Segrep GetOpenSearchOpensearchUserConfigOpensearchSegrep: Segment Replication Backpressure Settings
ShardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure: Shard indexing back pressure settings
ThreadPoolAnalyzeQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolAnalyzeSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolForceMergeSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolGetQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolGetSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolSearchQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolSearchSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolSearchThrottledQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolSearchThrottledSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolWriteQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolWriteSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ActionAutoCreateIndexEnabled bool: Explicitly allow or block automatic creation of indices. Defaults to true.
ActionDestructiveRequiresName bool: Require explicit index names when deleting.
AuthFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners: Opensearch Security Plugin Settings
ClusterMaxShardsPerNode int: Controls the number of shards allowed in the cluster per data node. Example: 1000.
ClusterRoutingAllocationBalancePreferPrimary bool: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
ClusterRoutingAllocationNodeConcurrentRecoveries int: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
ClusterSearchRequestSlowlog GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog
DiskWatermarks GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks: Watermark settings
EmailSenderName string: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
EmailSenderPassword string: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
EmailSenderUsername string: Sender username for Opensearch alerts. Example: jane@example.com.
EnableRemoteBackedStorage bool: Enable remote-backed storage.
EnableSecurityAudit bool: Enable/Disable security audit.
HttpMaxContentLength int: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
HttpMaxHeaderSize int: The max size of allowed headers, in bytes. Example: 8192.
HttpMaxInitialLineLength int: The max length of an HTTP URL, in bytes. Example: 4096.
IndicesFielddataCacheSize int: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
IndicesMemoryIndexBufferSize int: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
IndicesMemoryMaxIndexBufferSize int: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
IndicesMemoryMinIndexBufferSize int: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
IndicesQueriesCacheSize int: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
IndicesQueryBoolMaxClauseCount int: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
IndicesRecoveryMaxBytesPerSec int: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
IndicesRecoveryMaxConcurrentFileChunks int: Number of file chunks sent in parallel for each recovery. Defaults to 2.
IsmEnabled bool: Specifies whether ISM is enabled or not.
IsmHistoryEnabled bool: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
IsmHistoryMaxAge int: The maximum age before rolling over the audit history index in hours. Example: 24.
IsmHistoryMaxDocs int: The maximum number of documents before rolling over the audit history index. Example: 2500000.
IsmHistoryRolloverCheckPeriod int: The time between rollover checks for the audit history index in hours. Example: 8.
IsmHistoryRolloverRetentionPeriod int: How long audit history indices are kept in days. Example: 30.
KnnMemoryCircuitBreakerEnabled bool: Enable or disable KNN memory circuit breaker. Defaults to true.
KnnMemoryCircuitBreakerLimit int: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
OverrideMainResponseVersion bool: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
PluginsAlertingFilterByBackendRoles bool: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
ReindexRemoteWhitelists []string: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
ScriptMaxCompilationsRate string: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
SearchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure: Search Backpressure Settings
SearchInsightsTopQueries GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries
SearchMaxBuckets int: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
Segrep GetOpenSearchOpensearchUserConfigOpensearchSegrep: Segment Replication Backpressure Settings
ShardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure: Shard indexing back pressure settings
ThreadPoolAnalyzeQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolAnalyzeSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolForceMergeSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolGetQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolGetSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolSearchQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolSearchSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolSearchThrottledQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolSearchThrottledSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
ThreadPoolWriteQueueSize int: Size for the thread pool queue. See documentation for exact details.
ThreadPoolWriteSize int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

actionAutoCreateIndexEnabled Boolean: Explicitly allow or block automatic creation of indices. Defaults to true.
actionDestructiveRequiresName Boolean: Require explicit index names when deleting.
authFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners: Opensearch Security Plugin Settings
clusterMaxShardsPerNode Integer: Controls the number of shards allowed in the cluster per data node. Example: 1000.
clusterRoutingAllocationBalancePreferPrimary Boolean: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
clusterRoutingAllocationNodeConcurrentRecoveries Integer: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
clusterSearchRequestSlowlog GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog
diskWatermarks GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks: Watermark settings
emailSenderName String: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
emailSenderPassword String: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
emailSenderUsername String: Sender username for Opensearch alerts. Example: jane@example.com.
enableRemoteBackedStorage Boolean: Enable remote-backed storage.
enableSecurityAudit Boolean: Enable/Disable security audit.
httpMaxContentLength Integer: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
httpMaxHeaderSize Integer: The max size of allowed headers, in bytes. Example: 8192.
httpMaxInitialLineLength Integer: The max length of an HTTP URL, in bytes. Example: 4096.
indicesFielddataCacheSize Integer: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
indicesMemoryIndexBufferSize Integer: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
indicesMemoryMaxIndexBufferSize Integer: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
indicesMemoryMinIndexBufferSize Integer: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
indicesQueriesCacheSize Integer: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
indicesQueryBoolMaxClauseCount Integer: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
indicesRecoveryMaxBytesPerSec Integer: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
indicesRecoveryMaxConcurrentFileChunks Integer: Number of file chunks sent in parallel for each recovery. Defaults to 2.
ismEnabled Boolean: Specifies whether ISM is enabled or not.
ismHistoryEnabled Boolean: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
ismHistoryMaxAge Integer: The maximum age before rolling over the audit history index in hours. Example: 24.
ismHistoryMaxDocs Integer: The maximum number of documents before rolling over the audit history index. Example: 2500000.
ismHistoryRolloverCheckPeriod Integer: The time between rollover checks for the audit history index in hours. Example: 8.
ismHistoryRolloverRetentionPeriod Integer: How long audit history indices are kept in days. Example: 30.
knnMemoryCircuitBreakerEnabled Boolean: Enable or disable KNN memory circuit breaker. Defaults to true.
knnMemoryCircuitBreakerLimit Integer: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
overrideMainResponseVersion Boolean: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
pluginsAlertingFilterByBackendRoles Boolean: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
reindexRemoteWhitelists List<String>: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
scriptMaxCompilationsRate String: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
searchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure: Search Backpressure Settings
searchInsightsTopQueries GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries
searchMaxBuckets Integer: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
segrep GetOpenSearchOpensearchUserConfigOpensearchSegrep: Segment Replication Backpressure Settings
shardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure: Shard indexing back pressure settings
threadPoolAnalyzeQueueSize Integer: Size for the thread pool queue. See documentation for exact details.
threadPoolAnalyzeSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolForceMergeSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolGetQueueSize Integer: Size for the thread pool queue. See documentation for exact details.
threadPoolGetSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchQueueSize Integer: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchThrottledQueueSize Integer: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchThrottledSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolWriteQueueSize Integer: Size for the thread pool queue. See documentation for exact details.
threadPoolWriteSize Integer: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

actionAutoCreateIndexEnabled boolean: Explicitly allow or block automatic creation of indices. Defaults to true.
actionDestructiveRequiresName boolean: Require explicit index names when deleting.
authFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners: Opensearch Security Plugin Settings
clusterMaxShardsPerNode number: Controls the number of shards allowed in the cluster per data node. Example: 1000.
clusterRoutingAllocationBalancePreferPrimary boolean: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
clusterRoutingAllocationNodeConcurrentRecoveries number: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
clusterSearchRequestSlowlog GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog
diskWatermarks GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks: Watermark settings
emailSenderName string: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
emailSenderPassword string: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
emailSenderUsername string: Sender username for Opensearch alerts. Example: jane@example.com.
enableRemoteBackedStorage boolean: Enable remote-backed storage.
enableSecurityAudit boolean: Enable/Disable security audit.
httpMaxContentLength number: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
httpMaxHeaderSize number: The max size of allowed headers, in bytes. Example: 8192.
httpMaxInitialLineLength number: The max length of an HTTP URL, in bytes. Example: 4096.
indicesFielddataCacheSize number: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
indicesMemoryIndexBufferSize number: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
indicesMemoryMaxIndexBufferSize number: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
indicesMemoryMinIndexBufferSize number: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
indicesQueriesCacheSize number: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
indicesQueryBoolMaxClauseCount number: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
indicesRecoveryMaxBytesPerSec number: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
indicesRecoveryMaxConcurrentFileChunks number: Number of file chunks sent in parallel for each recovery. Defaults to 2.
ismEnabled boolean: Specifies whether ISM is enabled or not.
ismHistoryEnabled boolean: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
ismHistoryMaxAge number: The maximum age before rolling over the audit history index in hours. Example: 24.
ismHistoryMaxDocs number: The maximum number of documents before rolling over the audit history index. Example: 2500000.
ismHistoryRolloverCheckPeriod number: The time between rollover checks for the audit history index in hours. Example: 8.
ismHistoryRolloverRetentionPeriod number: How long audit history indices are kept in days. Example: 30.
knnMemoryCircuitBreakerEnabled boolean: Enable or disable KNN memory circuit breaker. Defaults to true.
knnMemoryCircuitBreakerLimit number: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
overrideMainResponseVersion boolean: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
pluginsAlertingFilterByBackendRoles boolean: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
reindexRemoteWhitelists string[]: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
scriptMaxCompilationsRate string: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
searchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure: Search Backpressure Settings
searchInsightsTopQueries GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries
searchMaxBuckets number: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
segrep GetOpenSearchOpensearchUserConfigOpensearchSegrep: Segment Replication Backpressure Settings
shardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure: Shard indexing back pressure settings
threadPoolAnalyzeQueueSize number: Size for the thread pool queue. See documentation for exact details.
threadPoolAnalyzeSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolForceMergeSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolGetQueueSize number: Size for the thread pool queue. See documentation for exact details.
threadPoolGetSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchQueueSize number: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchThrottledQueueSize number: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchThrottledSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolWriteQueueSize number: Size for the thread pool queue. See documentation for exact details.
threadPoolWriteSize number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

action_auto_create_index_enabled bool: Explicitly allow or block automatic creation of indices. Defaults to true.
action_destructive_requires_name bool: Require explicit index names when deleting.
auth_failure_listeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners: Opensearch Security Plugin Settings
cluster_max_shards_per_node int: Controls the number of shards allowed in the cluster per data node. Example: 1000.
cluster_routing_allocation_balance_prefer_primary bool: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
cluster_routing_allocation_node_concurrent_recoveries int: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
cluster_search_request_slowlog GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog
disk_watermarks GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks: Watermark settings
email_sender_name str: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
email_sender_password str: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
email_sender_username str: Sender username for Opensearch alerts. Example: jane@example.com.
enable_remote_backed_storage bool: Enable remote-backed storage.
enable_security_audit bool: Enable/Disable security audit.
http_max_content_length int: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
http_max_header_size int: The max size of allowed headers, in bytes. Example: 8192.
http_max_initial_line_length int: The max length of an HTTP URL, in bytes. Example: 4096.
indices_fielddata_cache_size int: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
indices_memory_index_buffer_size int: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
indices_memory_max_index_buffer_size int: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
indices_memory_min_index_buffer_size int: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
indices_queries_cache_size int: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
indices_query_bool_max_clause_count int: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
indices_recovery_max_bytes_per_sec int: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
indices_recovery_max_concurrent_file_chunks int: Number of file chunks sent in parallel for each recovery. Defaults to 2.
ism_enabled bool: Specifies whether ISM is enabled or not.
ism_history_enabled bool: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
ism_history_max_age int: The maximum age before rolling over the audit history index in hours. Example: 24.
ism_history_max_docs int: The maximum number of documents before rolling over the audit history index. Example: 2500000.
ism_history_rollover_check_period int: The time between rollover checks for the audit history index in hours. Example: 8.
ism_history_rollover_retention_period int: How long audit history indices are kept in days. Example: 30.
knn_memory_circuit_breaker_enabled bool: Enable or disable KNN memory circuit breaker. Defaults to true.
knn_memory_circuit_breaker_limit int: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
override_main_response_version bool: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
plugins_alerting_filter_by_backend_roles bool: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
reindex_remote_whitelists Sequence[str]: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
script_max_compilations_rate str: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
search_backpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure: Search Backpressure Settings
search_insights_top_queries GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries
search_max_buckets int: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
segrep GetOpenSearchOpensearchUserConfigOpensearchSegrep: Segment Replication Backpressure Settings
shard_indexing_pressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure: Shard indexing back pressure settings
thread_pool_analyze_queue_size int: Size for the thread pool queue. See documentation for exact details.
thread_pool_analyze_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
thread_pool_force_merge_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
thread_pool_get_queue_size int: Size for the thread pool queue. See documentation for exact details.
thread_pool_get_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
thread_pool_search_queue_size int: Size for the thread pool queue. See documentation for exact details.
thread_pool_search_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
thread_pool_search_throttled_queue_size int: Size for the thread pool queue. See documentation for exact details.
thread_pool_search_throttled_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
thread_pool_write_queue_size int: Size for the thread pool queue. See documentation for exact details.
thread_pool_write_size int: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

actionAutoCreateIndexEnabled Boolean: Explicitly allow or block automatic creation of indices. Defaults to true.
actionDestructiveRequiresName Boolean: Require explicit index names when deleting.
authFailureListeners Property Map: Opensearch Security Plugin Settings
clusterMaxShardsPerNode Number: Controls the number of shards allowed in the cluster per data node. Example: 1000.
clusterRoutingAllocationBalancePreferPrimary Boolean: When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. Default: false.
clusterRoutingAllocationNodeConcurrentRecoveries Number: How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
clusterSearchRequestSlowlog Property Map
diskWatermarks Property Map: Watermark settings
emailSenderName String: Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.
emailSenderPassword String: Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.
emailSenderUsername String: Sender username for Opensearch alerts. Example: jane@example.com.
enableRemoteBackedStorage Boolean: Enable remote-backed storage.
enableSecurityAudit Boolean: Enable/Disable security audit.
httpMaxContentLength Number: Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
httpMaxHeaderSize Number: The max size of allowed headers, in bytes. Example: 8192.
httpMaxInitialLineLength Number: The max length of an HTTP URL, in bytes. Example: 4096.
indicesFielddataCacheSize Number: Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
indicesMemoryIndexBufferSize Number: Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
indicesMemoryMaxIndexBufferSize Number: Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.
indicesMemoryMinIndexBufferSize Number: Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.
indicesQueriesCacheSize Number: Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
indicesQueryBoolMaxClauseCount Number: Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
indicesRecoveryMaxBytesPerSec Number: Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
indicesRecoveryMaxConcurrentFileChunks Number: Number of file chunks sent in parallel for each recovery. Defaults to 2.
ismEnabled Boolean: Specifies whether ISM is enabled or not.
ismHistoryEnabled Boolean: Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
ismHistoryMaxAge Number: The maximum age before rolling over the audit history index in hours. Example: 24.
ismHistoryMaxDocs Number: The maximum number of documents before rolling over the audit history index. Example: 2500000.
ismHistoryRolloverCheckPeriod Number: The time between rollover checks for the audit history index in hours. Example: 8.
ismHistoryRolloverRetentionPeriod Number: How long audit history indices are kept in days. Example: 30.
knnMemoryCircuitBreakerEnabled Boolean: Enable or disable KNN memory circuit breaker. Defaults to true.
knnMemoryCircuitBreakerLimit Number: Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.
overrideMainResponseVersion Boolean: Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
pluginsAlertingFilterByBackendRoles Boolean: Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
reindexRemoteWhitelists List<String>: Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
scriptMaxCompilationsRate String: Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.
searchBackpressure Property Map: Search Backpressure Settings
searchInsightsTopQueries Property Map
searchMaxBuckets Number: Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.
segrep Property Map: Segment Replication Backpressure Settings
shardIndexingPressure Property Map: Shard indexing back pressure settings
threadPoolAnalyzeQueueSize Number: Size for the thread pool queue. See documentation for exact details.
threadPoolAnalyzeSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolForceMergeSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolGetQueueSize Number: Size for the thread pool queue. See documentation for exact details.
threadPoolGetSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchQueueSize Number: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolSearchThrottledQueueSize Number: Size for the thread pool queue. See documentation for exact details.
threadPoolSearchThrottledSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
threadPoolWriteQueueSize Number: Size for the thread pool queue. See documentation for exact details.
threadPoolWriteSize Number: Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners

InternalAuthenticationBackendLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting
IpRateLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting: IP address rate limiting settings
Deprecated: This property is deprecated.

InternalAuthenticationBackendLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting
IpRateLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting: IP address rate limiting settings
Deprecated: This property is deprecated.

internalAuthenticationBackendLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting
ipRateLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting: IP address rate limiting settings
Deprecated: This property is deprecated.

internalAuthenticationBackendLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting
ipRateLimiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting: IP address rate limiting settings
Deprecated: This property is deprecated.

internal_authentication_backend_limiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting
ip_rate_limiting GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting: IP address rate limiting settings
Deprecated: This property is deprecated.

internalAuthenticationBackendLimiting Property Map
ipRateLimiting Property Map: IP address rate limiting settings
Deprecated: This property is deprecated.

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting

AllowedTries int: The number of login attempts allowed before login is blocked. Example: 10.
AuthenticationBackend string: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
BlockExpirySeconds int: The duration of time that login remains blocked after a failed login. Example: 600.
MaxBlockedClients int: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
MaxTrackedClients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
TimeWindowSeconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
Type string: Enum: username. internal_authentication_backend_limiting.type.

AllowedTries int: The number of login attempts allowed before login is blocked. Example: 10.
AuthenticationBackend string: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
BlockExpirySeconds int: The duration of time that login remains blocked after a failed login. Example: 600.
MaxBlockedClients int: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
MaxTrackedClients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
TimeWindowSeconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
Type string: Enum: username. internal_authentication_backend_limiting.type.

allowedTries Integer: The number of login attempts allowed before login is blocked. Example: 10.
authenticationBackend String: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
blockExpirySeconds Integer: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients Integer: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
maxTrackedClients Integer: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds Integer: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type String: Enum: username. internal_authentication_backend_limiting.type.

allowedTries number: The number of login attempts allowed before login is blocked. Example: 10.
authenticationBackend string: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
blockExpirySeconds number: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients number: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
maxTrackedClients number: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds number: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type string: Enum: username. internal_authentication_backend_limiting.type.

allowed_tries int: The number of login attempts allowed before login is blocked. Example: 10.
authentication_backend str: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
block_expiry_seconds int: The duration of time that login remains blocked after a failed login. Example: 600.
max_blocked_clients int: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
max_tracked_clients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
time_window_seconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type str: Enum: username. internal_authentication_backend_limiting.type.

allowedTries Number: The number of login attempts allowed before login is blocked. Example: 10.
authenticationBackend String: Enum: internal. internal_authentication_backend_limiting.authentication_backend.
blockExpirySeconds Number: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients Number: internal_authentication_backend_limiting.max_blocked_clients. Example: 100000.
maxTrackedClients Number: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds Number: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type String: Enum: username. internal_authentication_backend_limiting.type.

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting

AllowedTries int: The number of login attempts allowed before login is blocked. Example: 10.
BlockExpirySeconds int: The duration of time that login remains blocked after a failed login. Example: 600.
MaxBlockedClients int: The maximum number of blocked IP addresses. Example: 100000.
MaxTrackedClients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
TimeWindowSeconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
Type string: Enum: ip. The type of rate limiting.

AllowedTries int: The number of login attempts allowed before login is blocked. Example: 10.
BlockExpirySeconds int: The duration of time that login remains blocked after a failed login. Example: 600.
MaxBlockedClients int: The maximum number of blocked IP addresses. Example: 100000.
MaxTrackedClients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
TimeWindowSeconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
Type string: Enum: ip. The type of rate limiting.

allowedTries Integer: The number of login attempts allowed before login is blocked. Example: 10.
blockExpirySeconds Integer: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients Integer: The maximum number of blocked IP addresses. Example: 100000.
maxTrackedClients Integer: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds Integer: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type String: Enum: ip. The type of rate limiting.

allowedTries number: The number of login attempts allowed before login is blocked. Example: 10.
blockExpirySeconds number: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients number: The maximum number of blocked IP addresses. Example: 100000.
maxTrackedClients number: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds number: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type string: Enum: ip. The type of rate limiting.

allowed_tries int: The number of login attempts allowed before login is blocked. Example: 10.
block_expiry_seconds int: The duration of time that login remains blocked after a failed login. Example: 600.
max_blocked_clients int: The maximum number of blocked IP addresses. Example: 100000.
max_tracked_clients int: The maximum number of tracked IP addresses that have failed login. Example: 100000.
time_window_seconds int: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type str: Enum: ip. The type of rate limiting.

allowedTries Number: The number of login attempts allowed before login is blocked. Example: 10.
blockExpirySeconds Number: The duration of time that login remains blocked after a failed login. Example: 600.
maxBlockedClients Number: The maximum number of blocked IP addresses. Example: 100000.
maxTrackedClients Number: The maximum number of tracked IP addresses that have failed login. Example: 100000.
timeWindowSeconds Number: The window of time in which the value for allowed_tries is enforced. Example: 3600.
type String: Enum: ip. The type of rate limiting.

GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog

Level string: Enum: debug, info, trace, warn. Log level. Default: trace.
Threshold GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

Level string: Enum: debug, info, trace, warn. Log level. Default: trace.
Threshold GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

level String: Enum: debug, info, trace, warn. Log level. Default: trace.
threshold GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

level string: Enum: debug, info, trace, warn. Log level. Default: trace.
threshold GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

level str: Enum: debug, info, trace, warn. Log level. Default: trace.
threshold GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

level String: Enum: debug, info, trace, warn. Log level. Default: trace.
threshold Property Map

GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

Debug string: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Info string: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Trace string: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Warn string: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

Debug string: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Info string: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Trace string: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
Warn string: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

debug String: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
info String: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
trace String: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
warn String: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

debug string: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
info string: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
trace string: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
warn string: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

debug str: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
info str: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
trace str: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
warn str: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

debug String: Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
info String: Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
trace String: Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.
warn String: Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1.

GetOpenSearchOpensearchUserConfigOpensearchDashboards

Enabled bool: Enable or disable OpenSearch Dashboards. Default: true.
MaxOldSpaceSize int: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
MultipleDataSourceEnabled bool: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
OpensearchRequestTimeout int: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

Enabled bool: Enable or disable OpenSearch Dashboards. Default: true.
MaxOldSpaceSize int: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
MultipleDataSourceEnabled bool: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
OpensearchRequestTimeout int: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

enabled Boolean: Enable or disable OpenSearch Dashboards. Default: true.
maxOldSpaceSize Integer: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
multipleDataSourceEnabled Boolean: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
opensearchRequestTimeout Integer: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

enabled boolean: Enable or disable OpenSearch Dashboards. Default: true.
maxOldSpaceSize number: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
multipleDataSourceEnabled boolean: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
opensearchRequestTimeout number: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

enabled bool: Enable or disable OpenSearch Dashboards. Default: true.
max_old_space_size int: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
multiple_data_source_enabled bool: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
opensearch_request_timeout int: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

enabled Boolean: Enable or disable OpenSearch Dashboards. Default: true.
maxOldSpaceSize Number: Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. Default: 128.
multipleDataSourceEnabled Boolean: Enable or disable multiple data sources in OpenSearch Dashboards. Default: true.
opensearchRequestTimeout Number: Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default: 30000.

GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks

FloodStage int: The flood stage watermark for disk usage. Example: 95.
High int: The high watermark for disk usage. Example: 90.
Low int: The low watermark for disk usage. Example: 85.

FloodStage int: The flood stage watermark for disk usage. Example: 95.
High int: The high watermark for disk usage. Example: 90.
Low int: The low watermark for disk usage. Example: 85.

floodStage Integer: The flood stage watermark for disk usage. Example: 95.
high Integer: The high watermark for disk usage. Example: 90.
low Integer: The low watermark for disk usage. Example: 85.

floodStage number: The flood stage watermark for disk usage. Example: 95.
high number: The high watermark for disk usage. Example: 90.
low number: The low watermark for disk usage. Example: 85.

flood_stage int: The flood stage watermark for disk usage. Example: 95.
high int: The high watermark for disk usage. Example: 90.
low int: The low watermark for disk usage. Example: 85.

floodStage Number: The flood stage watermark for disk usage. Example: 95.
high Number: The high watermark for disk usage. Example: 90.
low Number: The low watermark for disk usage. Example: 85.

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure

Mode string: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
NodeDuress GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress: Node duress settings
SearchShardTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask: Search shard settings
SearchTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask: Search task settings

Mode string: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
NodeDuress GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress: Node duress settings
SearchShardTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask: Search shard settings
SearchTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask: Search task settings

mode String: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
nodeDuress GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress: Node duress settings
searchShardTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask: Search shard settings
searchTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask: Search task settings

mode string: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
nodeDuress GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress: Node duress settings
searchShardTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask: Search shard settings
searchTask GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask: Search task settings

mode str: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
node_duress GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress: Node duress settings
search_shard_task GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask: Search shard settings
search_task GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask: Search task settings

mode String: Enum: disabled, enforced, monitor_only. The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only.
nodeDuress Property Map: Node duress settings
searchShardTask Property Map: Search shard settings
searchTask Property Map: Search task settings

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress

CpuThreshold double: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
HeapThreshold double: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
NumSuccessiveBreaches int: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

CpuThreshold float64: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
HeapThreshold float64: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
NumSuccessiveBreaches int: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

cpuThreshold Double: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
heapThreshold Double: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
numSuccessiveBreaches Integer: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

cpuThreshold number: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
heapThreshold number: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
numSuccessiveBreaches number: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

cpu_threshold float: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
heap_threshold float: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
num_successive_breaches int: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

cpuThreshold Number: The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
heapThreshold Number: The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
numSuccessiveBreaches Number: The number of successive limit breaches after which the node is considered to be under duress. Default is 3.

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask

CancellationBurst double: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
CancellationRate double: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
CancellationRatio double: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
CpuTimeMillisThreshold int: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
ElapsedTimeMillisThreshold int: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
HeapMovingAverageWindowSize int: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
HeapPercentThreshold double: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
HeapVariance double: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
TotalHeapPercentThreshold double: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

CancellationBurst float64: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
CancellationRate float64: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
CancellationRatio float64: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
CpuTimeMillisThreshold int: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
ElapsedTimeMillisThreshold int: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
HeapMovingAverageWindowSize int: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
HeapPercentThreshold float64: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
HeapVariance float64: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
TotalHeapPercentThreshold float64: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

cancellationBurst Double: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
cancellationRate Double: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio Double: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
cpuTimeMillisThreshold Integer: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
elapsedTimeMillisThreshold Integer: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
heapMovingAverageWindowSize Integer: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
heapPercentThreshold Double: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
heapVariance Double: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
totalHeapPercentThreshold Double: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

cancellationBurst number: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
cancellationRate number: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio number: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
cpuTimeMillisThreshold number: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
elapsedTimeMillisThreshold number: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
heapMovingAverageWindowSize number: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
heapPercentThreshold number: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
heapVariance number: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
totalHeapPercentThreshold number: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

cancellation_burst float: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
cancellation_rate float: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellation_ratio float: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
cpu_time_millis_threshold int: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
elapsed_time_millis_threshold int: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
heap_moving_average_window_size int: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
heap_percent_threshold float: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
heap_variance float: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
total_heap_percent_threshold float: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

cancellationBurst Number: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
cancellationRate Number: The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio Number: The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
cpuTimeMillisThreshold Number: The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
elapsedTimeMillisThreshold Number: The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
heapMovingAverageWindowSize Number: The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
heapPercentThreshold Number: The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5.
heapVariance Number: The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0.
totalHeapPercentThreshold Number: The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5.

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask

CancellationBurst double: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
CancellationRate double: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
CancellationRatio double: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
CpuTimeMillisThreshold int: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
ElapsedTimeMillisThreshold int: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
HeapMovingAverageWindowSize int: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
HeapPercentThreshold double: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
HeapVariance double: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
TotalHeapPercentThreshold double: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

CancellationBurst float64: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
CancellationRate float64: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
CancellationRatio float64: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
CpuTimeMillisThreshold int: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
ElapsedTimeMillisThreshold int: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
HeapMovingAverageWindowSize int: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
HeapPercentThreshold float64: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
HeapVariance float64: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
TotalHeapPercentThreshold float64: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

cancellationBurst Double: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
cancellationRate Double: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio Double: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
cpuTimeMillisThreshold Integer: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
elapsedTimeMillisThreshold Integer: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
heapMovingAverageWindowSize Integer: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
heapPercentThreshold Double: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
heapVariance Double: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
totalHeapPercentThreshold Double: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

cancellationBurst number: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
cancellationRate number: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio number: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
cpuTimeMillisThreshold number: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
elapsedTimeMillisThreshold number: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
heapMovingAverageWindowSize number: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
heapPercentThreshold number: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
heapVariance number: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
totalHeapPercentThreshold number: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

cancellation_burst float: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
cancellation_rate float: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellation_ratio float: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
cpu_time_millis_threshold int: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
elapsed_time_millis_threshold int: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
heap_moving_average_window_size int: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
heap_percent_threshold float: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
heap_variance float: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
total_heap_percent_threshold float: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

cancellationBurst Number: The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
cancellationRate Number: The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
cancellationRatio Number: The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
cpuTimeMillisThreshold Number: The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
elapsedTimeMillisThreshold Number: The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
heapMovingAverageWindowSize Number: The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
heapPercentThreshold Number: The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2.
heapVariance Number: The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0.
totalHeapPercentThreshold Number: The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5.

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries

Cpu GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu: Top N queries monitoring by CPU
Latency GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency: Top N queries monitoring by latency
Memory GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory: Top N queries monitoring by memory

Cpu GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu: Top N queries monitoring by CPU
Latency GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency: Top N queries monitoring by latency
Memory GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory: Top N queries monitoring by memory

cpu GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu: Top N queries monitoring by CPU
latency GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency: Top N queries monitoring by latency
memory GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory: Top N queries monitoring by memory

cpu GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu: Top N queries monitoring by CPU
latency GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency: Top N queries monitoring by latency
memory GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory: Top N queries monitoring by memory

cpu GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu: Top N queries monitoring by CPU
latency GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency: Top N queries monitoring by latency
memory GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory: Top N queries monitoring by memory

cpu Property Map: Top N queries monitoring by CPU
latency Property Map: Top N queries monitoring by latency
memory Property Map: Top N queries monitoring by memory

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Integer: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

enabled boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize number: Specify the value of N for the top N queries by the metric.
windowSize string: The window size of the top N queries by the metric.

enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
top_n_size int: Specify the value of N for the top N queries by the metric.
window_size str: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Number: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Integer: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

enabled boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize number: Specify the value of N for the top N queries by the metric.
windowSize string: The window size of the top N queries by the metric.

enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
top_n_size int: Specify the value of N for the top N queries by the metric.
window_size str: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Number: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

Enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
TopNSize int: Specify the value of N for the top N queries by the metric.
WindowSize string: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Integer: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

enabled boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize number: Specify the value of N for the top N queries by the metric.
windowSize string: The window size of the top N queries by the metric.

enabled bool: Enable or disable top N query monitoring by the metric. Default: false.
top_n_size int: Specify the value of N for the top N queries by the metric.
window_size str: The window size of the top N queries by the metric.

enabled Boolean: Enable or disable top N query monitoring by the metric. Default: false.
topNSize Number: Specify the value of N for the top N queries by the metric.
windowSize String: The window size of the top N queries by the metric.

GetOpenSearchOpensearchUserConfigOpensearchSegrep

PressureCheckpointLimit int: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
PressureEnabled bool: Enables the segment replication backpressure mechanism. Default is false. Default: false.
PressureReplicaStaleLimit double: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
PressureTimeLimit string: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

PressureCheckpointLimit int: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
PressureEnabled bool: Enables the segment replication backpressure mechanism. Default is false. Default: false.
PressureReplicaStaleLimit float64: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
PressureTimeLimit string: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

pressureCheckpointLimit Integer: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
pressureEnabled Boolean: Enables the segment replication backpressure mechanism. Default is false. Default: false.
pressureReplicaStaleLimit Double: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
pressureTimeLimit String: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

pressureCheckpointLimit number: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
pressureEnabled boolean: Enables the segment replication backpressure mechanism. Default is false. Default: false.
pressureReplicaStaleLimit number: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
pressureTimeLimit string: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

pressure_checkpoint_limit int: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
pressure_enabled bool: Enables the segment replication backpressure mechanism. Default is false. Default: false.
pressure_replica_stale_limit float: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
pressure_time_limit str: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

pressureCheckpointLimit Number: The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default: 4.
pressureEnabled Boolean: Enables the segment replication backpressure mechanism. Default is false. Default: false.
pressureReplicaStaleLimit Number: The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default: 0.5.
pressureTimeLimit String: The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: 5m.

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure

Enabled bool: Enable or disable shard indexing backpressure. Default is false.
Enforced bool: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
OperatingFactor GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor: Operating factor
PrimaryParameter GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter: Primary parameter

Enabled bool: Enable or disable shard indexing backpressure. Default is false.
Enforced bool: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
OperatingFactor GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor: Operating factor
PrimaryParameter GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter: Primary parameter

enabled Boolean: Enable or disable shard indexing backpressure. Default is false.
enforced Boolean: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
operatingFactor GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor: Operating factor
primaryParameter GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter: Primary parameter

enabled boolean: Enable or disable shard indexing backpressure. Default is false.
enforced boolean: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
operatingFactor GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor: Operating factor
primaryParameter GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter: Primary parameter

enabled bool: Enable or disable shard indexing backpressure. Default is false.
enforced bool: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
operating_factor GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor: Operating factor
primary_parameter GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter: Primary parameter

enabled Boolean: Enable or disable shard indexing backpressure. Default is false.
enforced Boolean: Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false.
operatingFactor Property Map: Operating factor
primaryParameter Property Map: Primary parameter

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor

Lower double: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
Optimal double: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
Upper double: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

Lower float64: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
Optimal float64: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
Upper float64: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

lower Double: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
optimal Double: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
upper Double: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

lower number: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
optimal number: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
upper number: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

lower float: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
optimal float: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
upper float: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

lower Number: Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75.
optimal Number: Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85.
upper Number: Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95.

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter

Node GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode
Shard GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

Node GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode
Shard GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

node GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode
shard GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

node GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode
shard GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

node GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode
shard GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

node Property Map
shard Property Map

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode

SoftLimit double: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

SoftLimit float64: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

softLimit Double: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

softLimit number: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

soft_limit float: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

softLimit Number: Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7.

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

MinLimit double: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

MinLimit float64: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

minLimit Double: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

minLimit number: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

min_limit float: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

minLimit Number: Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001.

GetOpenSearchOpensearchUserConfigPrivateAccess

Opensearch bool: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
OpensearchDashboards bool: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

Opensearch bool: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
OpensearchDashboards bool: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
Prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

opensearch Boolean: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
opensearchDashboards Boolean: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

opensearch boolean: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
opensearchDashboards boolean: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

opensearch bool: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
opensearch_dashboards bool: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

opensearch Boolean: Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
opensearchDashboards Boolean: Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
prometheus Boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Opensearch bool: Enable opensearch.
OpensearchDashboards bool: Enable opensearch_dashboards.
Prometheus bool: Enable prometheus.

Opensearch bool: Enable opensearch.
OpensearchDashboards bool: Enable opensearch_dashboards.
Prometheus bool: Enable prometheus.

opensearch Boolean: Enable opensearch.
opensearchDashboards Boolean: Enable opensearch_dashboards.
prometheus Boolean: Enable prometheus.

opensearch boolean: Enable opensearch.
opensearchDashboards boolean: Enable opensearch_dashboards.
prometheus boolean: Enable prometheus.

opensearch bool: Enable opensearch.
opensearch_dashboards bool: Enable opensearch_dashboards.
prometheus bool: Enable prometheus.

opensearch Boolean: Enable opensearch.
opensearchDashboards Boolean: Enable opensearch_dashboards.
prometheus Boolean: Enable prometheus.

GetOpenSearchOpensearchUserConfigPublicAccess

Opensearch bool: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
OpensearchDashboards bool: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
Prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

Opensearch bool: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
OpensearchDashboards bool: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
Prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

opensearch Boolean: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
opensearchDashboards Boolean: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

opensearch boolean: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
opensearchDashboards boolean: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

opensearch bool: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
opensearch_dashboards bool: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

opensearch Boolean: Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.
opensearchDashboards Boolean: Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.
prometheus Boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

GetOpenSearchOpensearchUserConfigS3Migration

AccessKey string: AWS Access key.
BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Bucket string: S3 bucket name.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
Region string: S3 region.
SecretKey string: AWS secret key.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
Endpoint string: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.
ServerSideEncryption bool: When set to true files are encrypted on server side.

AccessKey string: AWS Access key.
BasePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
Bucket string: S3 bucket name.
Indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
Region string: S3 region.
SecretKey string: AWS secret key.
SnapshotName string: The snapshot name to restore from.
ChunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
Compress bool: When set to true metadata files are stored in compressed format.
Endpoint string: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
IncludeAliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
Readonly bool: Whether the repository is read-only. Default: true.
RestoreGlobalState bool: If true, restore the cluster state. Defaults to false.
ServerSideEncryption bool: When set to true files are encrypted on server side.

accessKey String: AWS Access key.
basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket String: S3 bucket name.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
region String: S3 region.
secretKey String: AWS secret key.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
endpoint String: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.
serverSideEncryption Boolean: When set to true files are encrypted on server side.

accessKey string: AWS Access key.
basePath string: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket string: S3 bucket name.
indices string: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
region string: S3 region.
secretKey string: AWS secret key.
snapshotName string: The snapshot name to restore from.
chunkSize string: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress boolean: When set to true metadata files are stored in compressed format.
endpoint string: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
includeAliases boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly boolean: Whether the repository is read-only. Default: true.
restoreGlobalState boolean: If true, restore the cluster state. Defaults to false.
serverSideEncryption boolean: When set to true files are encrypted on server side.

access_key str: AWS Access key.
base_path str: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket str: S3 bucket name.
indices str: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
region str: S3 region.
secret_key str: AWS secret key.
snapshot_name str: The snapshot name to restore from.
chunk_size str: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress bool: When set to true metadata files are stored in compressed format.
endpoint str: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
include_aliases bool: Whether to restore aliases alongside their associated indexes. Default is true.
readonly bool: Whether the repository is read-only. Default: true.
restore_global_state bool: If true, restore the cluster state. Defaults to false.
server_side_encryption bool: When set to true files are encrypted on server side.

accessKey String: AWS Access key.
basePath String: The path to the repository data within its container. The value of this setting should not start or end with a /.
bucket String: S3 bucket name.
indices String: A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.
region String: S3 region.
secretKey String: AWS secret key.
snapshotName String: The snapshot name to restore from.
chunkSize String: Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.
compress Boolean: When set to true metadata files are stored in compressed format.
endpoint String: The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint.
includeAliases Boolean: Whether to restore aliases alongside their associated indexes. Default is true.
readonly Boolean: Whether the repository is read-only. Default: true.
restoreGlobalState Boolean: If true, restore the cluster state. Defaults to false.
serverSideEncryption Boolean: When set to true files are encrypted on server side.

GetOpenSearchOpensearchUserConfigSaml

Enabled bool: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
IdpEntityId string: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
IdpMetadataUrl string: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
SpEntityId string: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
IdpPemtrustedcasContent string: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
RolesKey string: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
SubjectKey string: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

Enabled bool: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
IdpEntityId string: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
IdpMetadataUrl string: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
SpEntityId string: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
IdpPemtrustedcasContent string: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
RolesKey string: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
SubjectKey string: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

enabled Boolean: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
idpEntityId String: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
idpMetadataUrl String: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
spEntityId String: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
idpPemtrustedcasContent String: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
rolesKey String: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
subjectKey String: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

enabled boolean: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
idpEntityId string: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
idpMetadataUrl string: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
spEntityId string: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
idpPemtrustedcasContent string: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
rolesKey string: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
subjectKey string: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

enabled bool: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
idp_entity_id str: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
idp_metadata_url str: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
sp_entity_id str: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
idp_pemtrustedcas_content str: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
roles_key str: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
subject_key str: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

enabled Boolean: Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. Default: true.
idpEntityId String: The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. Example: test-idp-entity-id.
idpMetadataUrl String: The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.
spEntityId String: The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. Example: test-sp-entity-id.
idpPemtrustedcasContent String: This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server. Example: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----.
rolesKey String: Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. Example: RoleName.
subjectKey String: Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. Example: NameID.

GetOpenSearchServiceIntegration

IntegrationType string: Type of the service integration
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration
source_service_name str: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

GetOpenSearchTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetOpenSearchTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email String: An email address to contact for technical issues

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

pulumi/pulumi-aiven

aiven.getOpenSearch

On this page

On this page

Example Usage

Using getOpenSearch

getOpenSearch Result

Supporting Types

GetOpenSearchComponent

GetOpenSearchOpensearch

GetOpenSearchOpensearchUserConfig

GetOpenSearchOpensearchUserConfigAzureMigration

GetOpenSearchOpensearchUserConfigGcsMigration

GetOpenSearchOpensearchUserConfigIndexPattern

GetOpenSearchOpensearchUserConfigIndexRollup

GetOpenSearchOpensearchUserConfigIndexTemplate

GetOpenSearchOpensearchUserConfigIpFilterObject

GetOpenSearchOpensearchUserConfigOpenid

GetOpenSearchOpensearchUserConfigOpensearch

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting

GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting

GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog

GetOpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold

GetOpenSearchOpensearchUserConfigOpensearchDashboards

GetOpenSearchOpensearchUserConfigOpensearchDiskWatermarks

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask

GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency

GetOpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory

GetOpenSearchOpensearchUserConfigOpensearchSegrep

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode

GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard

GetOpenSearchOpensearchUserConfigPrivateAccess

GetOpenSearchOpensearchUserConfigPrivatelinkAccess

GetOpenSearchOpensearchUserConfigPublicAccess

GetOpenSearchOpensearchUserConfigS3Migration

GetOpenSearchOpensearchUserConfigSaml

GetOpenSearchServiceIntegration

GetOpenSearchTag

GetOpenSearchTechEmail

Package Details

On this page

On this page