Aiven v6.44.0 published on Friday, Oct 10, 2025 by Pulumi
aiven.OpenSearch
Creates and manages an Aiven for OpenSearch® service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleOpensearch = new aiven.OpenSearch("example_opensearch", {
project: exampleProject.project,
cloudName: "google-europe-west1",
plan: "startup-4",
serviceName: "example-opensearch",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
opensearchUserConfig: {
opensearchDashboards: {
enabled: true,
opensearchRequestTimeout: 30000,
},
publicAccess: {
opensearch: true,
opensearchDashboards: true,
},
},
});
import pulumi
import pulumi_aiven as aiven
example_opensearch = aiven.OpenSearch("example_opensearch",
project=example_project["project"],
cloud_name="google-europe-west1",
plan="startup-4",
service_name="example-opensearch",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
opensearch_user_config={
"opensearch_dashboards": {
"enabled": True,
"opensearch_request_timeout": 30000,
},
"public_access": {
"opensearch": True,
"opensearch_dashboards": True,
},
})
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.NewOpenSearch(ctx, "example_opensearch", &aiven.OpenSearchArgs{
Project: pulumi.Any(exampleProject.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("startup-4"),
ServiceName: pulumi.String("example-opensearch"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
OpensearchUserConfig: &aiven.OpenSearchOpensearchUserConfigArgs{
OpensearchDashboards: &aiven.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs{
Enabled: pulumi.Bool(true),
OpensearchRequestTimeout: pulumi.Int(30000),
},
PublicAccess: &aiven.OpenSearchOpensearchUserConfigPublicAccessArgs{
Opensearch: pulumi.Bool(true),
OpensearchDashboards: pulumi.Bool(true),
},
},
})
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 exampleOpensearch = new Aiven.OpenSearch("example_opensearch", new()
{
Project = exampleProject.Project,
CloudName = "google-europe-west1",
Plan = "startup-4",
ServiceName = "example-opensearch",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
OpensearchUserConfig = new Aiven.Inputs.OpenSearchOpensearchUserConfigArgs
{
OpensearchDashboards = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs
{
Enabled = true,
OpensearchRequestTimeout = 30000,
},
PublicAccess = new Aiven.Inputs.OpenSearchOpensearchUserConfigPublicAccessArgs
{
Opensearch = true,
OpensearchDashboards = true,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.OpenSearch;
import com.pulumi.aiven.OpenSearchArgs;
import com.pulumi.aiven.inputs.OpenSearchOpensearchUserConfigArgs;
import com.pulumi.aiven.inputs.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs;
import com.pulumi.aiven.inputs.OpenSearchOpensearchUserConfigPublicAccessArgs;
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) {
var exampleOpensearch = new OpenSearch("exampleOpensearch", OpenSearchArgs.builder()
.project(exampleProject.project())
.cloudName("google-europe-west1")
.plan("startup-4")
.serviceName("example-opensearch")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.opensearchUserConfig(OpenSearchOpensearchUserConfigArgs.builder()
.opensearchDashboards(OpenSearchOpensearchUserConfigOpensearchDashboardsArgs.builder()
.enabled(true)
.opensearchRequestTimeout(30000)
.build())
.publicAccess(OpenSearchOpensearchUserConfigPublicAccessArgs.builder()
.opensearch(true)
.opensearchDashboards(true)
.build())
.build())
.build());
}
}
resources:
exampleOpensearch:
type: aiven:OpenSearch
name: example_opensearch
properties:
project: ${exampleProject.project}
cloudName: google-europe-west1
plan: startup-4
serviceName: example-opensearch
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
opensearchUserConfig:
opensearchDashboards:
enabled: true
opensearchRequestTimeout: 30000
publicAccess:
opensearch: true
opensearchDashboards: true
Create OpenSearch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OpenSearch(name: string, args: OpenSearchArgs, opts?: CustomResourceOptions);@overload
def OpenSearch(resource_name: str,
args: OpenSearchArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OpenSearch(resource_name: str,
opts: Optional[ResourceOptions] = None,
plan: Optional[str] = None,
service_name: Optional[str] = None,
project: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
additional_disk_space: Optional[str] = None,
opensearch_user_config: Optional[OpenSearchOpensearchUserConfigArgs] = None,
opensearches: Optional[Sequence[OpenSearchOpensearchArgs]] = None,
maintenance_window_dow: Optional[str] = None,
disk_space: Optional[str] = None,
project_vpc_id: Optional[str] = None,
service_integrations: Optional[Sequence[OpenSearchServiceIntegrationArgs]] = None,
cloud_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[OpenSearchTagArgs]] = None,
tech_emails: Optional[Sequence[OpenSearchTechEmailArgs]] = None,
termination_protection: Optional[bool] = None)func NewOpenSearch(ctx *Context, name string, args OpenSearchArgs, opts ...ResourceOption) (*OpenSearch, error)public OpenSearch(string name, OpenSearchArgs args, CustomResourceOptions? opts = null)
public OpenSearch(String name, OpenSearchArgs args)
public OpenSearch(String name, OpenSearchArgs args, CustomResourceOptions options)
type: aiven:OpenSearch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OpenSearchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OpenSearchArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OpenSearchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OpenSearchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OpenSearchArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var openSearchResource = new Aiven.OpenSearch("openSearchResource", new()
{
Plan = "string",
ServiceName = "string",
Project = "string",
MaintenanceWindowTime = "string",
AdditionalDiskSpace = "string",
OpensearchUserConfig = new Aiven.Inputs.OpenSearchOpensearchUserConfigArgs
{
AdditionalBackupRegions = "string",
AzureMigration = new Aiven.Inputs.OpenSearchOpensearchUserConfigAzureMigrationArgs
{
Account = "string",
BasePath = "string",
SnapshotName = "string",
Indices = "string",
Container = "string",
IncludeAliases = false,
EndpointSuffix = "string",
Compress = false,
Key = "string",
Readonly = false,
RestoreGlobalState = false,
SasToken = "string",
ChunkSize = "string",
},
CustomDomain = "string",
DisableReplicationFactorAdjustment = false,
GcsMigration = new Aiven.Inputs.OpenSearchOpensearchUserConfigGcsMigrationArgs
{
BasePath = "string",
Bucket = "string",
Credentials = "string",
Indices = "string",
SnapshotName = "string",
ChunkSize = "string",
Compress = false,
IncludeAliases = false,
Readonly = false,
RestoreGlobalState = false,
},
IndexPatterns = new[]
{
new Aiven.Inputs.OpenSearchOpensearchUserConfigIndexPatternArgs
{
MaxIndexCount = 0,
Pattern = "string",
SortingAlgorithm = "string",
},
},
IndexRollup = new Aiven.Inputs.OpenSearchOpensearchUserConfigIndexRollupArgs
{
RollupDashboardsEnabled = false,
RollupEnabled = false,
RollupSearchBackoffCount = 0,
RollupSearchBackoffMillis = 0,
RollupSearchSearchAllJobs = false,
},
IndexTemplate = new Aiven.Inputs.OpenSearchOpensearchUserConfigIndexTemplateArgs
{
MappingNestedObjectsLimit = 0,
NumberOfReplicas = 0,
NumberOfShards = 0,
},
IpFilterObjects = new[]
{
new Aiven.Inputs.OpenSearchOpensearchUserConfigIpFilterObjectArgs
{
Network = "string",
Description = "string",
},
},
IpFilterStrings = new[]
{
"string",
},
KeepIndexRefreshInterval = false,
MaxIndexCount = 0,
Openid = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpenidArgs
{
ClientId = "string",
ClientSecret = "string",
ConnectUrl = "string",
Enabled = false,
Header = "string",
JwtHeader = "string",
JwtUrlParameter = "string",
RefreshRateLimitCount = 0,
RefreshRateLimitTimeWindowMs = 0,
RolesKey = "string",
Scope = "string",
SubjectKey = "string",
},
Opensearch = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchArgs
{
ActionAutoCreateIndexEnabled = false,
ActionDestructiveRequiresName = false,
AuthFailureListeners = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersArgs
{
InternalAuthenticationBackendLimiting = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimitingArgs
{
AllowedTries = 0,
AuthenticationBackend = "string",
BlockExpirySeconds = 0,
MaxBlockedClients = 0,
MaxTrackedClients = 0,
TimeWindowSeconds = 0,
Type = "string",
},
},
ClusterFilecacheRemoteDataRatio = 0,
ClusterMaxShardsPerNode = 0,
ClusterRemoteStore = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchClusterRemoteStoreArgs
{
StateGlobalMetadataUploadTimeout = "string",
StateMetadataManifestUploadTimeout = "string",
TranslogBufferInterval = "string",
TranslogMaxReaders = 0,
},
ClusterRoutingAllocationBalancePreferPrimary = false,
ClusterRoutingAllocationNodeConcurrentRecoveries = 0,
ClusterSearchRequestSlowlog = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogArgs
{
Level = "string",
Threshold = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThresholdArgs
{
Debug = "string",
Info = "string",
Trace = "string",
Warn = "string",
},
},
DiskWatermarks = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchDiskWatermarksArgs
{
FloodStage = 0,
High = 0,
Low = 0,
},
EmailSenderName = "string",
EmailSenderPassword = "string",
EmailSenderUsername = "string",
EnableRemoteBackedStorage = false,
EnableSearchableSnapshots = false,
EnableSecurityAudit = false,
EnableSnapshotApi = false,
HttpMaxContentLength = 0,
HttpMaxHeaderSize = 0,
HttpMaxInitialLineLength = 0,
IndicesFielddataCacheSize = 0,
IndicesMemoryIndexBufferSize = 0,
IndicesMemoryMaxIndexBufferSize = 0,
IndicesMemoryMinIndexBufferSize = 0,
IndicesQueriesCacheSize = 0,
IndicesQueryBoolMaxClauseCount = 0,
IndicesRecoveryMaxBytesPerSec = 0,
IndicesRecoveryMaxConcurrentFileChunks = 0,
IsmEnabled = false,
IsmHistoryEnabled = false,
IsmHistoryMaxAge = 0,
IsmHistoryMaxDocs = 0,
IsmHistoryRolloverCheckPeriod = 0,
IsmHistoryRolloverRetentionPeriod = 0,
KnnMemoryCircuitBreakerEnabled = false,
KnnMemoryCircuitBreakerLimit = 0,
NodeSearchCacheSize = "string",
OverrideMainResponseVersion = false,
PluginsAlertingFilterByBackendRoles = false,
ReindexRemoteWhitelists = new[]
{
"string",
},
RemoteStore = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchRemoteStoreArgs
{
SegmentPressureBytesLagVarianceFactor = 0,
SegmentPressureConsecutiveFailuresLimit = 0,
SegmentPressureEnabled = false,
SegmentPressureTimeLagVarianceFactor = 0,
},
ScriptMaxCompilationsRate = "string",
SearchBackpressure = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureArgs
{
Mode = "string",
NodeDuress = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuressArgs
{
CpuThreshold = 0,
HeapThreshold = 0,
NumSuccessiveBreaches = 0,
},
SearchShardTask = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTaskArgs
{
CancellationBurst = 0,
CancellationRate = 0,
CancellationRatio = 0,
CpuTimeMillisThreshold = 0,
ElapsedTimeMillisThreshold = 0,
HeapMovingAverageWindowSize = 0,
HeapPercentThreshold = 0,
HeapVariance = 0,
TotalHeapPercentThreshold = 0,
},
SearchTask = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTaskArgs
{
CancellationBurst = 0,
CancellationRate = 0,
CancellationRatio = 0,
CpuTimeMillisThreshold = 0,
ElapsedTimeMillisThreshold = 0,
HeapMovingAverageWindowSize = 0,
HeapPercentThreshold = 0,
HeapVariance = 0,
TotalHeapPercentThreshold = 0,
},
},
SearchInsightsTopQueries = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesArgs
{
Cpu = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpuArgs
{
Enabled = false,
TopNSize = 0,
WindowSize = "string",
},
Latency = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatencyArgs
{
Enabled = false,
TopNSize = 0,
WindowSize = "string",
},
Memory = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemoryArgs
{
Enabled = false,
TopNSize = 0,
WindowSize = "string",
},
},
SearchMaxBuckets = 0,
Segrep = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchSegrepArgs
{
PressureCheckpointLimit = 0,
PressureEnabled = false,
PressureReplicaStaleLimit = 0,
PressureTimeLimit = "string",
},
ShardIndexingPressure = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureArgs
{
Enabled = false,
Enforced = false,
OperatingFactor = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactorArgs
{
Lower = 0,
Optimal = 0,
Upper = 0,
},
PrimaryParameter = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterArgs
{
Node = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNodeArgs
{
SoftLimit = 0,
},
Shard = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShardArgs
{
MinLimit = 0,
},
},
},
ThreadPoolAnalyzeQueueSize = 0,
ThreadPoolAnalyzeSize = 0,
ThreadPoolForceMergeSize = 0,
ThreadPoolGetQueueSize = 0,
ThreadPoolGetSize = 0,
ThreadPoolSearchQueueSize = 0,
ThreadPoolSearchSize = 0,
ThreadPoolSearchThrottledQueueSize = 0,
ThreadPoolSearchThrottledSize = 0,
ThreadPoolWriteQueueSize = 0,
ThreadPoolWriteSize = 0,
},
OpensearchDashboards = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs
{
Enabled = false,
MaxOldSpaceSize = 0,
MultipleDataSourceEnabled = false,
OpensearchRequestTimeout = 0,
},
OpensearchVersion = "string",
PrivateAccess = new Aiven.Inputs.OpenSearchOpensearchUserConfigPrivateAccessArgs
{
Opensearch = false,
OpensearchDashboards = false,
Prometheus = false,
},
PrivatelinkAccess = new Aiven.Inputs.OpenSearchOpensearchUserConfigPrivatelinkAccessArgs
{
Opensearch = false,
OpensearchDashboards = false,
Prometheus = false,
},
ProjectToForkFrom = "string",
PublicAccess = new Aiven.Inputs.OpenSearchOpensearchUserConfigPublicAccessArgs
{
Opensearch = false,
OpensearchDashboards = false,
Prometheus = false,
},
RecoveryBasebackupName = "string",
S3Migration = new Aiven.Inputs.OpenSearchOpensearchUserConfigS3MigrationArgs
{
Indices = "string",
BasePath = "string",
Bucket = "string",
AccessKey = "string",
SnapshotName = "string",
SecretKey = "string",
Region = "string",
ChunkSize = "string",
Readonly = false,
IncludeAliases = false,
RestoreGlobalState = false,
Endpoint = "string",
ServerSideEncryption = false,
Compress = false,
},
Saml = new Aiven.Inputs.OpenSearchOpensearchUserConfigSamlArgs
{
Enabled = false,
IdpEntityId = "string",
IdpMetadataUrl = "string",
SpEntityId = "string",
IdpPemtrustedcasContent = "string",
RolesKey = "string",
SubjectKey = "string",
},
ServiceLog = false,
ServiceToForkFrom = "string",
StaticIps = false,
},
Opensearches = new[]
{
new Aiven.Inputs.OpenSearchOpensearchArgs
{
OpensearchDashboardsUri = "string",
Password = "string",
Uris = new[]
{
"string",
},
Username = "string",
},
},
MaintenanceWindowDow = "string",
ProjectVpcId = "string",
ServiceIntegrations = new[]
{
new Aiven.Inputs.OpenSearchServiceIntegrationArgs
{
IntegrationType = "string",
SourceServiceName = "string",
},
},
CloudName = "string",
StaticIps = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.OpenSearchTagArgs
{
Key = "string",
Value = "string",
},
},
TechEmails = new[]
{
new Aiven.Inputs.OpenSearchTechEmailArgs
{
Email = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewOpenSearch(ctx, "openSearchResource", &aiven.OpenSearchArgs{
Plan: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Project: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
AdditionalDiskSpace: pulumi.String("string"),
OpensearchUserConfig: &aiven.OpenSearchOpensearchUserConfigArgs{
AdditionalBackupRegions: pulumi.String("string"),
AzureMigration: &aiven.OpenSearchOpensearchUserConfigAzureMigrationArgs{
Account: pulumi.String("string"),
BasePath: pulumi.String("string"),
SnapshotName: pulumi.String("string"),
Indices: pulumi.String("string"),
Container: pulumi.String("string"),
IncludeAliases: pulumi.Bool(false),
EndpointSuffix: pulumi.String("string"),
Compress: pulumi.Bool(false),
Key: pulumi.String("string"),
Readonly: pulumi.Bool(false),
RestoreGlobalState: pulumi.Bool(false),
SasToken: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
},
CustomDomain: pulumi.String("string"),
DisableReplicationFactorAdjustment: pulumi.Bool(false),
GcsMigration: &aiven.OpenSearchOpensearchUserConfigGcsMigrationArgs{
BasePath: pulumi.String("string"),
Bucket: pulumi.String("string"),
Credentials: pulumi.String("string"),
Indices: pulumi.String("string"),
SnapshotName: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Compress: pulumi.Bool(false),
IncludeAliases: pulumi.Bool(false),
Readonly: pulumi.Bool(false),
RestoreGlobalState: pulumi.Bool(false),
},
IndexPatterns: aiven.OpenSearchOpensearchUserConfigIndexPatternArray{
&aiven.OpenSearchOpensearchUserConfigIndexPatternArgs{
MaxIndexCount: pulumi.Int(0),
Pattern: pulumi.String("string"),
SortingAlgorithm: pulumi.String("string"),
},
},
IndexRollup: &aiven.OpenSearchOpensearchUserConfigIndexRollupArgs{
RollupDashboardsEnabled: pulumi.Bool(false),
RollupEnabled: pulumi.Bool(false),
RollupSearchBackoffCount: pulumi.Int(0),
RollupSearchBackoffMillis: pulumi.Int(0),
RollupSearchSearchAllJobs: pulumi.Bool(false),
},
IndexTemplate: &aiven.OpenSearchOpensearchUserConfigIndexTemplateArgs{
MappingNestedObjectsLimit: pulumi.Int(0),
NumberOfReplicas: pulumi.Int(0),
NumberOfShards: pulumi.Int(0),
},
IpFilterObjects: aiven.OpenSearchOpensearchUserConfigIpFilterObjectArray{
&aiven.OpenSearchOpensearchUserConfigIpFilterObjectArgs{
Network: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
IpFilterStrings: pulumi.StringArray{
pulumi.String("string"),
},
KeepIndexRefreshInterval: pulumi.Bool(false),
MaxIndexCount: pulumi.Int(0),
Openid: &aiven.OpenSearchOpensearchUserConfigOpenidArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ConnectUrl: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Header: pulumi.String("string"),
JwtHeader: pulumi.String("string"),
JwtUrlParameter: pulumi.String("string"),
RefreshRateLimitCount: pulumi.Int(0),
RefreshRateLimitTimeWindowMs: pulumi.Int(0),
RolesKey: pulumi.String("string"),
Scope: pulumi.String("string"),
SubjectKey: pulumi.String("string"),
},
Opensearch: &aiven.OpenSearchOpensearchUserConfigOpensearchArgs{
ActionAutoCreateIndexEnabled: pulumi.Bool(false),
ActionDestructiveRequiresName: pulumi.Bool(false),
AuthFailureListeners: &aiven.OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersArgs{
InternalAuthenticationBackendLimiting: &aiven.OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimitingArgs{
AllowedTries: pulumi.Int(0),
AuthenticationBackend: pulumi.String("string"),
BlockExpirySeconds: pulumi.Int(0),
MaxBlockedClients: pulumi.Int(0),
MaxTrackedClients: pulumi.Int(0),
TimeWindowSeconds: pulumi.Int(0),
Type: pulumi.String("string"),
},
},
ClusterFilecacheRemoteDataRatio: pulumi.Float64(0),
ClusterMaxShardsPerNode: pulumi.Int(0),
ClusterRemoteStore: &aiven.OpenSearchOpensearchUserConfigOpensearchClusterRemoteStoreArgs{
StateGlobalMetadataUploadTimeout: pulumi.String("string"),
StateMetadataManifestUploadTimeout: pulumi.String("string"),
TranslogBufferInterval: pulumi.String("string"),
TranslogMaxReaders: pulumi.Int(0),
},
ClusterRoutingAllocationBalancePreferPrimary: pulumi.Bool(false),
ClusterRoutingAllocationNodeConcurrentRecoveries: pulumi.Int(0),
ClusterSearchRequestSlowlog: &aiven.OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogArgs{
Level: pulumi.String("string"),
Threshold: &aiven.OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThresholdArgs{
Debug: pulumi.String("string"),
Info: pulumi.String("string"),
Trace: pulumi.String("string"),
Warn: pulumi.String("string"),
},
},
DiskWatermarks: &aiven.OpenSearchOpensearchUserConfigOpensearchDiskWatermarksArgs{
FloodStage: pulumi.Int(0),
High: pulumi.Int(0),
Low: pulumi.Int(0),
},
EmailSenderName: pulumi.String("string"),
EmailSenderPassword: pulumi.String("string"),
EmailSenderUsername: pulumi.String("string"),
EnableRemoteBackedStorage: pulumi.Bool(false),
EnableSearchableSnapshots: pulumi.Bool(false),
EnableSecurityAudit: pulumi.Bool(false),
EnableSnapshotApi: pulumi.Bool(false),
HttpMaxContentLength: pulumi.Int(0),
HttpMaxHeaderSize: pulumi.Int(0),
HttpMaxInitialLineLength: pulumi.Int(0),
IndicesFielddataCacheSize: pulumi.Int(0),
IndicesMemoryIndexBufferSize: pulumi.Int(0),
IndicesMemoryMaxIndexBufferSize: pulumi.Int(0),
IndicesMemoryMinIndexBufferSize: pulumi.Int(0),
IndicesQueriesCacheSize: pulumi.Int(0),
IndicesQueryBoolMaxClauseCount: pulumi.Int(0),
IndicesRecoveryMaxBytesPerSec: pulumi.Int(0),
IndicesRecoveryMaxConcurrentFileChunks: pulumi.Int(0),
IsmEnabled: pulumi.Bool(false),
IsmHistoryEnabled: pulumi.Bool(false),
IsmHistoryMaxAge: pulumi.Int(0),
IsmHistoryMaxDocs: pulumi.Int(0),
IsmHistoryRolloverCheckPeriod: pulumi.Int(0),
IsmHistoryRolloverRetentionPeriod: pulumi.Int(0),
KnnMemoryCircuitBreakerEnabled: pulumi.Bool(false),
KnnMemoryCircuitBreakerLimit: pulumi.Int(0),
NodeSearchCacheSize: pulumi.String("string"),
OverrideMainResponseVersion: pulumi.Bool(false),
PluginsAlertingFilterByBackendRoles: pulumi.Bool(false),
ReindexRemoteWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
RemoteStore: &aiven.OpenSearchOpensearchUserConfigOpensearchRemoteStoreArgs{
SegmentPressureBytesLagVarianceFactor: pulumi.Float64(0),
SegmentPressureConsecutiveFailuresLimit: pulumi.Int(0),
SegmentPressureEnabled: pulumi.Bool(false),
SegmentPressureTimeLagVarianceFactor: pulumi.Float64(0),
},
ScriptMaxCompilationsRate: pulumi.String("string"),
SearchBackpressure: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureArgs{
Mode: pulumi.String("string"),
NodeDuress: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuressArgs{
CpuThreshold: pulumi.Float64(0),
HeapThreshold: pulumi.Float64(0),
NumSuccessiveBreaches: pulumi.Int(0),
},
SearchShardTask: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTaskArgs{
CancellationBurst: pulumi.Float64(0),
CancellationRate: pulumi.Float64(0),
CancellationRatio: pulumi.Float64(0),
CpuTimeMillisThreshold: pulumi.Int(0),
ElapsedTimeMillisThreshold: pulumi.Int(0),
HeapMovingAverageWindowSize: pulumi.Int(0),
HeapPercentThreshold: pulumi.Float64(0),
HeapVariance: pulumi.Float64(0),
TotalHeapPercentThreshold: pulumi.Float64(0),
},
SearchTask: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTaskArgs{
CancellationBurst: pulumi.Float64(0),
CancellationRate: pulumi.Float64(0),
CancellationRatio: pulumi.Float64(0),
CpuTimeMillisThreshold: pulumi.Int(0),
ElapsedTimeMillisThreshold: pulumi.Int(0),
HeapMovingAverageWindowSize: pulumi.Int(0),
HeapPercentThreshold: pulumi.Float64(0),
HeapVariance: pulumi.Float64(0),
TotalHeapPercentThreshold: pulumi.Float64(0),
},
},
SearchInsightsTopQueries: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesArgs{
Cpu: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpuArgs{
Enabled: pulumi.Bool(false),
TopNSize: pulumi.Int(0),
WindowSize: pulumi.String("string"),
},
Latency: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatencyArgs{
Enabled: pulumi.Bool(false),
TopNSize: pulumi.Int(0),
WindowSize: pulumi.String("string"),
},
Memory: &aiven.OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemoryArgs{
Enabled: pulumi.Bool(false),
TopNSize: pulumi.Int(0),
WindowSize: pulumi.String("string"),
},
},
SearchMaxBuckets: pulumi.Int(0),
Segrep: &aiven.OpenSearchOpensearchUserConfigOpensearchSegrepArgs{
PressureCheckpointLimit: pulumi.Int(0),
PressureEnabled: pulumi.Bool(false),
PressureReplicaStaleLimit: pulumi.Float64(0),
PressureTimeLimit: pulumi.String("string"),
},
ShardIndexingPressure: &aiven.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureArgs{
Enabled: pulumi.Bool(false),
Enforced: pulumi.Bool(false),
OperatingFactor: &aiven.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactorArgs{
Lower: pulumi.Float64(0),
Optimal: pulumi.Float64(0),
Upper: pulumi.Float64(0),
},
PrimaryParameter: &aiven.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterArgs{
Node: &aiven.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNodeArgs{
SoftLimit: pulumi.Float64(0),
},
Shard: &aiven.OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShardArgs{
MinLimit: pulumi.Float64(0),
},
},
},
ThreadPoolAnalyzeQueueSize: pulumi.Int(0),
ThreadPoolAnalyzeSize: pulumi.Int(0),
ThreadPoolForceMergeSize: pulumi.Int(0),
ThreadPoolGetQueueSize: pulumi.Int(0),
ThreadPoolGetSize: pulumi.Int(0),
ThreadPoolSearchQueueSize: pulumi.Int(0),
ThreadPoolSearchSize: pulumi.Int(0),
ThreadPoolSearchThrottledQueueSize: pulumi.Int(0),
ThreadPoolSearchThrottledSize: pulumi.Int(0),
ThreadPoolWriteQueueSize: pulumi.Int(0),
ThreadPoolWriteSize: pulumi.Int(0),
},
OpensearchDashboards: &aiven.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs{
Enabled: pulumi.Bool(false),
MaxOldSpaceSize: pulumi.Int(0),
MultipleDataSourceEnabled: pulumi.Bool(false),
OpensearchRequestTimeout: pulumi.Int(0),
},
OpensearchVersion: pulumi.String("string"),
PrivateAccess: &aiven.OpenSearchOpensearchUserConfigPrivateAccessArgs{
Opensearch: pulumi.Bool(false),
OpensearchDashboards: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
},
PrivatelinkAccess: &aiven.OpenSearchOpensearchUserConfigPrivatelinkAccessArgs{
Opensearch: pulumi.Bool(false),
OpensearchDashboards: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
},
ProjectToForkFrom: pulumi.String("string"),
PublicAccess: &aiven.OpenSearchOpensearchUserConfigPublicAccessArgs{
Opensearch: pulumi.Bool(false),
OpensearchDashboards: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
},
RecoveryBasebackupName: pulumi.String("string"),
S3Migration: &aiven.OpenSearchOpensearchUserConfigS3MigrationArgs{
Indices: pulumi.String("string"),
BasePath: pulumi.String("string"),
Bucket: pulumi.String("string"),
AccessKey: pulumi.String("string"),
SnapshotName: pulumi.String("string"),
SecretKey: pulumi.String("string"),
Region: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Readonly: pulumi.Bool(false),
IncludeAliases: pulumi.Bool(false),
RestoreGlobalState: pulumi.Bool(false),
Endpoint: pulumi.String("string"),
ServerSideEncryption: pulumi.Bool(false),
Compress: pulumi.Bool(false),
},
Saml: &aiven.OpenSearchOpensearchUserConfigSamlArgs{
Enabled: pulumi.Bool(false),
IdpEntityId: pulumi.String("string"),
IdpMetadataUrl: pulumi.String("string"),
SpEntityId: pulumi.String("string"),
IdpPemtrustedcasContent: pulumi.String("string"),
RolesKey: pulumi.String("string"),
SubjectKey: pulumi.String("string"),
},
ServiceLog: pulumi.Bool(false),
ServiceToForkFrom: pulumi.String("string"),
StaticIps: pulumi.Bool(false),
},
Opensearches: aiven.OpenSearchOpensearchArray{
&aiven.OpenSearchOpensearchArgs{
OpensearchDashboardsUri: pulumi.String("string"),
Password: pulumi.String("string"),
Uris: pulumi.StringArray{
pulumi.String("string"),
},
Username: pulumi.String("string"),
},
},
MaintenanceWindowDow: pulumi.String("string"),
ProjectVpcId: pulumi.String("string"),
ServiceIntegrations: aiven.OpenSearchServiceIntegrationArray{
&aiven.OpenSearchServiceIntegrationArgs{
IntegrationType: pulumi.String("string"),
SourceServiceName: pulumi.String("string"),
},
},
CloudName: pulumi.String("string"),
StaticIps: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.OpenSearchTagArray{
&aiven.OpenSearchTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TechEmails: aiven.OpenSearchTechEmailArray{
&aiven.OpenSearchTechEmailArgs{
Email: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var openSearchResource = new OpenSearch("openSearchResource", OpenSearchArgs.builder()
.plan("string")
.serviceName("string")
.project("string")
.maintenanceWindowTime("string")
.additionalDiskSpace("string")
.opensearchUserConfig(OpenSearchOpensearchUserConfigArgs.builder()
.additionalBackupRegions("string")
.azureMigration(OpenSearchOpensearchUserConfigAzureMigrationArgs.builder()
.account("string")
.basePath("string")
.snapshotName("string")
.indices("string")
.container("string")
.includeAliases(false)
.endpointSuffix("string")
.compress(false)
.key("string")
.readonly(false)
.restoreGlobalState(false)
.sasToken("string")
.chunkSize("string")
.build())
.customDomain("string")
.disableReplicationFactorAdjustment(false)
.gcsMigration(OpenSearchOpensearchUserConfigGcsMigrationArgs.builder()
.basePath("string")
.bucket("string")
.credentials("string")
.indices("string")
.snapshotName("string")
.chunkSize("string")
.compress(false)
.includeAliases(false)
.readonly(false)
.restoreGlobalState(false)
.build())
.indexPatterns(OpenSearchOpensearchUserConfigIndexPatternArgs.builder()
.maxIndexCount(0)
.pattern("string")
.sortingAlgorithm("string")
.build())
.indexRollup(OpenSearchOpensearchUserConfigIndexRollupArgs.builder()
.rollupDashboardsEnabled(false)
.rollupEnabled(false)
.rollupSearchBackoffCount(0)
.rollupSearchBackoffMillis(0)
.rollupSearchSearchAllJobs(false)
.build())
.indexTemplate(OpenSearchOpensearchUserConfigIndexTemplateArgs.builder()
.mappingNestedObjectsLimit(0)
.numberOfReplicas(0)
.numberOfShards(0)
.build())
.ipFilterObjects(OpenSearchOpensearchUserConfigIpFilterObjectArgs.builder()
.network("string")
.description("string")
.build())
.ipFilterStrings("string")
.keepIndexRefreshInterval(false)
.maxIndexCount(0)
.openid(OpenSearchOpensearchUserConfigOpenidArgs.builder()
.clientId("string")
.clientSecret("string")
.connectUrl("string")
.enabled(false)
.header("string")
.jwtHeader("string")
.jwtUrlParameter("string")
.refreshRateLimitCount(0)
.refreshRateLimitTimeWindowMs(0)
.rolesKey("string")
.scope("string")
.subjectKey("string")
.build())
.opensearch(OpenSearchOpensearchUserConfigOpensearchArgs.builder()
.actionAutoCreateIndexEnabled(false)
.actionDestructiveRequiresName(false)
.authFailureListeners(OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersArgs.builder()
.internalAuthenticationBackendLimiting(OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimitingArgs.builder()
.allowedTries(0)
.authenticationBackend("string")
.blockExpirySeconds(0)
.maxBlockedClients(0)
.maxTrackedClients(0)
.timeWindowSeconds(0)
.type("string")
.build())
.build())
.clusterFilecacheRemoteDataRatio(0.0)
.clusterMaxShardsPerNode(0)
.clusterRemoteStore(OpenSearchOpensearchUserConfigOpensearchClusterRemoteStoreArgs.builder()
.stateGlobalMetadataUploadTimeout("string")
.stateMetadataManifestUploadTimeout("string")
.translogBufferInterval("string")
.translogMaxReaders(0)
.build())
.clusterRoutingAllocationBalancePreferPrimary(false)
.clusterRoutingAllocationNodeConcurrentRecoveries(0)
.clusterSearchRequestSlowlog(OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogArgs.builder()
.level("string")
.threshold(OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThresholdArgs.builder()
.debug("string")
.info("string")
.trace("string")
.warn("string")
.build())
.build())
.diskWatermarks(OpenSearchOpensearchUserConfigOpensearchDiskWatermarksArgs.builder()
.floodStage(0)
.high(0)
.low(0)
.build())
.emailSenderName("string")
.emailSenderPassword("string")
.emailSenderUsername("string")
.enableRemoteBackedStorage(false)
.enableSearchableSnapshots(false)
.enableSecurityAudit(false)
.enableSnapshotApi(false)
.httpMaxContentLength(0)
.httpMaxHeaderSize(0)
.httpMaxInitialLineLength(0)
.indicesFielddataCacheSize(0)
.indicesMemoryIndexBufferSize(0)
.indicesMemoryMaxIndexBufferSize(0)
.indicesMemoryMinIndexBufferSize(0)
.indicesQueriesCacheSize(0)
.indicesQueryBoolMaxClauseCount(0)
.indicesRecoveryMaxBytesPerSec(0)
.indicesRecoveryMaxConcurrentFileChunks(0)
.ismEnabled(false)
.ismHistoryEnabled(false)
.ismHistoryMaxAge(0)
.ismHistoryMaxDocs(0)
.ismHistoryRolloverCheckPeriod(0)
.ismHistoryRolloverRetentionPeriod(0)
.knnMemoryCircuitBreakerEnabled(false)
.knnMemoryCircuitBreakerLimit(0)
.nodeSearchCacheSize("string")
.overrideMainResponseVersion(false)
.pluginsAlertingFilterByBackendRoles(false)
.reindexRemoteWhitelists("string")
.remoteStore(OpenSearchOpensearchUserConfigOpensearchRemoteStoreArgs.builder()
.segmentPressureBytesLagVarianceFactor(0.0)
.segmentPressureConsecutiveFailuresLimit(0)
.segmentPressureEnabled(false)
.segmentPressureTimeLagVarianceFactor(0.0)
.build())
.scriptMaxCompilationsRate("string")
.searchBackpressure(OpenSearchOpensearchUserConfigOpensearchSearchBackpressureArgs.builder()
.mode("string")
.nodeDuress(OpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuressArgs.builder()
.cpuThreshold(0.0)
.heapThreshold(0.0)
.numSuccessiveBreaches(0)
.build())
.searchShardTask(OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTaskArgs.builder()
.cancellationBurst(0.0)
.cancellationRate(0.0)
.cancellationRatio(0.0)
.cpuTimeMillisThreshold(0)
.elapsedTimeMillisThreshold(0)
.heapMovingAverageWindowSize(0)
.heapPercentThreshold(0.0)
.heapVariance(0.0)
.totalHeapPercentThreshold(0.0)
.build())
.searchTask(OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTaskArgs.builder()
.cancellationBurst(0.0)
.cancellationRate(0.0)
.cancellationRatio(0.0)
.cpuTimeMillisThreshold(0)
.elapsedTimeMillisThreshold(0)
.heapMovingAverageWindowSize(0)
.heapPercentThreshold(0.0)
.heapVariance(0.0)
.totalHeapPercentThreshold(0.0)
.build())
.build())
.searchInsightsTopQueries(OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesArgs.builder()
.cpu(OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpuArgs.builder()
.enabled(false)
.topNSize(0)
.windowSize("string")
.build())
.latency(OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatencyArgs.builder()
.enabled(false)
.topNSize(0)
.windowSize("string")
.build())
.memory(OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemoryArgs.builder()
.enabled(false)
.topNSize(0)
.windowSize("string")
.build())
.build())
.searchMaxBuckets(0)
.segrep(OpenSearchOpensearchUserConfigOpensearchSegrepArgs.builder()
.pressureCheckpointLimit(0)
.pressureEnabled(false)
.pressureReplicaStaleLimit(0.0)
.pressureTimeLimit("string")
.build())
.shardIndexingPressure(OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureArgs.builder()
.enabled(false)
.enforced(false)
.operatingFactor(OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactorArgs.builder()
.lower(0.0)
.optimal(0.0)
.upper(0.0)
.build())
.primaryParameter(OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterArgs.builder()
.node(OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNodeArgs.builder()
.softLimit(0.0)
.build())
.shard(OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShardArgs.builder()
.minLimit(0.0)
.build())
.build())
.build())
.threadPoolAnalyzeQueueSize(0)
.threadPoolAnalyzeSize(0)
.threadPoolForceMergeSize(0)
.threadPoolGetQueueSize(0)
.threadPoolGetSize(0)
.threadPoolSearchQueueSize(0)
.threadPoolSearchSize(0)
.threadPoolSearchThrottledQueueSize(0)
.threadPoolSearchThrottledSize(0)
.threadPoolWriteQueueSize(0)
.threadPoolWriteSize(0)
.build())
.opensearchDashboards(OpenSearchOpensearchUserConfigOpensearchDashboardsArgs.builder()
.enabled(false)
.maxOldSpaceSize(0)
.multipleDataSourceEnabled(false)
.opensearchRequestTimeout(0)
.build())
.opensearchVersion("string")
.privateAccess(OpenSearchOpensearchUserConfigPrivateAccessArgs.builder()
.opensearch(false)
.opensearchDashboards(false)
.prometheus(false)
.build())
.privatelinkAccess(OpenSearchOpensearchUserConfigPrivatelinkAccessArgs.builder()
.opensearch(false)
.opensearchDashboards(false)
.prometheus(false)
.build())
.projectToForkFrom("string")
.publicAccess(OpenSearchOpensearchUserConfigPublicAccessArgs.builder()
.opensearch(false)
.opensearchDashboards(false)
.prometheus(false)
.build())
.recoveryBasebackupName("string")
.s3Migration(OpenSearchOpensearchUserConfigS3MigrationArgs.builder()
.indices("string")
.basePath("string")
.bucket("string")
.accessKey("string")
.snapshotName("string")
.secretKey("string")
.region("string")
.chunkSize("string")
.readonly(false)
.includeAliases(false)
.restoreGlobalState(false)
.endpoint("string")
.serverSideEncryption(false)
.compress(false)
.build())
.saml(OpenSearchOpensearchUserConfigSamlArgs.builder()
.enabled(false)
.idpEntityId("string")
.idpMetadataUrl("string")
.spEntityId("string")
.idpPemtrustedcasContent("string")
.rolesKey("string")
.subjectKey("string")
.build())
.serviceLog(false)
.serviceToForkFrom("string")
.staticIps(false)
.build())
.opensearches(OpenSearchOpensearchArgs.builder()
.opensearchDashboardsUri("string")
.password("string")
.uris("string")
.username("string")
.build())
.maintenanceWindowDow("string")
.projectVpcId("string")
.serviceIntegrations(OpenSearchServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cloudName("string")
.staticIps("string")
.tags(OpenSearchTagArgs.builder()
.key("string")
.value("string")
.build())
.techEmails(OpenSearchTechEmailArgs.builder()
.email("string")
.build())
.terminationProtection(false)
.build());
open_search_resource = aiven.OpenSearch("openSearchResource",
plan="string",
service_name="string",
project="string",
maintenance_window_time="string",
additional_disk_space="string",
opensearch_user_config={
"additional_backup_regions": "string",
"azure_migration": {
"account": "string",
"base_path": "string",
"snapshot_name": "string",
"indices": "string",
"container": "string",
"include_aliases": False,
"endpoint_suffix": "string",
"compress": False,
"key": "string",
"readonly": False,
"restore_global_state": False,
"sas_token": "string",
"chunk_size": "string",
},
"custom_domain": "string",
"disable_replication_factor_adjustment": False,
"gcs_migration": {
"base_path": "string",
"bucket": "string",
"credentials": "string",
"indices": "string",
"snapshot_name": "string",
"chunk_size": "string",
"compress": False,
"include_aliases": False,
"readonly": False,
"restore_global_state": False,
},
"index_patterns": [{
"max_index_count": 0,
"pattern": "string",
"sorting_algorithm": "string",
}],
"index_rollup": {
"rollup_dashboards_enabled": False,
"rollup_enabled": False,
"rollup_search_backoff_count": 0,
"rollup_search_backoff_millis": 0,
"rollup_search_search_all_jobs": False,
},
"index_template": {
"mapping_nested_objects_limit": 0,
"number_of_replicas": 0,
"number_of_shards": 0,
},
"ip_filter_objects": [{
"network": "string",
"description": "string",
}],
"ip_filter_strings": ["string"],
"keep_index_refresh_interval": False,
"max_index_count": 0,
"openid": {
"client_id": "string",
"client_secret": "string",
"connect_url": "string",
"enabled": False,
"header": "string",
"jwt_header": "string",
"jwt_url_parameter": "string",
"refresh_rate_limit_count": 0,
"refresh_rate_limit_time_window_ms": 0,
"roles_key": "string",
"scope": "string",
"subject_key": "string",
},
"opensearch": {
"action_auto_create_index_enabled": False,
"action_destructive_requires_name": False,
"auth_failure_listeners": {
"internal_authentication_backend_limiting": {
"allowed_tries": 0,
"authentication_backend": "string",
"block_expiry_seconds": 0,
"max_blocked_clients": 0,
"max_tracked_clients": 0,
"time_window_seconds": 0,
"type": "string",
},
},
"cluster_filecache_remote_data_ratio": 0,
"cluster_max_shards_per_node": 0,
"cluster_remote_store": {
"state_global_metadata_upload_timeout": "string",
"state_metadata_manifest_upload_timeout": "string",
"translog_buffer_interval": "string",
"translog_max_readers": 0,
},
"cluster_routing_allocation_balance_prefer_primary": False,
"cluster_routing_allocation_node_concurrent_recoveries": 0,
"cluster_search_request_slowlog": {
"level": "string",
"threshold": {
"debug": "string",
"info": "string",
"trace": "string",
"warn": "string",
},
},
"disk_watermarks": {
"flood_stage": 0,
"high": 0,
"low": 0,
},
"email_sender_name": "string",
"email_sender_password": "string",
"email_sender_username": "string",
"enable_remote_backed_storage": False,
"enable_searchable_snapshots": False,
"enable_security_audit": False,
"enable_snapshot_api": False,
"http_max_content_length": 0,
"http_max_header_size": 0,
"http_max_initial_line_length": 0,
"indices_fielddata_cache_size": 0,
"indices_memory_index_buffer_size": 0,
"indices_memory_max_index_buffer_size": 0,
"indices_memory_min_index_buffer_size": 0,
"indices_queries_cache_size": 0,
"indices_query_bool_max_clause_count": 0,
"indices_recovery_max_bytes_per_sec": 0,
"indices_recovery_max_concurrent_file_chunks": 0,
"ism_enabled": False,
"ism_history_enabled": False,
"ism_history_max_age": 0,
"ism_history_max_docs": 0,
"ism_history_rollover_check_period": 0,
"ism_history_rollover_retention_period": 0,
"knn_memory_circuit_breaker_enabled": False,
"knn_memory_circuit_breaker_limit": 0,
"node_search_cache_size": "string",
"override_main_response_version": False,
"plugins_alerting_filter_by_backend_roles": False,
"reindex_remote_whitelists": ["string"],
"remote_store": {
"segment_pressure_bytes_lag_variance_factor": 0,
"segment_pressure_consecutive_failures_limit": 0,
"segment_pressure_enabled": False,
"segment_pressure_time_lag_variance_factor": 0,
},
"script_max_compilations_rate": "string",
"search_backpressure": {
"mode": "string",
"node_duress": {
"cpu_threshold": 0,
"heap_threshold": 0,
"num_successive_breaches": 0,
},
"search_shard_task": {
"cancellation_burst": 0,
"cancellation_rate": 0,
"cancellation_ratio": 0,
"cpu_time_millis_threshold": 0,
"elapsed_time_millis_threshold": 0,
"heap_moving_average_window_size": 0,
"heap_percent_threshold": 0,
"heap_variance": 0,
"total_heap_percent_threshold": 0,
},
"search_task": {
"cancellation_burst": 0,
"cancellation_rate": 0,
"cancellation_ratio": 0,
"cpu_time_millis_threshold": 0,
"elapsed_time_millis_threshold": 0,
"heap_moving_average_window_size": 0,
"heap_percent_threshold": 0,
"heap_variance": 0,
"total_heap_percent_threshold": 0,
},
},
"search_insights_top_queries": {
"cpu": {
"enabled": False,
"top_n_size": 0,
"window_size": "string",
},
"latency": {
"enabled": False,
"top_n_size": 0,
"window_size": "string",
},
"memory": {
"enabled": False,
"top_n_size": 0,
"window_size": "string",
},
},
"search_max_buckets": 0,
"segrep": {
"pressure_checkpoint_limit": 0,
"pressure_enabled": False,
"pressure_replica_stale_limit": 0,
"pressure_time_limit": "string",
},
"shard_indexing_pressure": {
"enabled": False,
"enforced": False,
"operating_factor": {
"lower": 0,
"optimal": 0,
"upper": 0,
},
"primary_parameter": {
"node": {
"soft_limit": 0,
},
"shard": {
"min_limit": 0,
},
},
},
"thread_pool_analyze_queue_size": 0,
"thread_pool_analyze_size": 0,
"thread_pool_force_merge_size": 0,
"thread_pool_get_queue_size": 0,
"thread_pool_get_size": 0,
"thread_pool_search_queue_size": 0,
"thread_pool_search_size": 0,
"thread_pool_search_throttled_queue_size": 0,
"thread_pool_search_throttled_size": 0,
"thread_pool_write_queue_size": 0,
"thread_pool_write_size": 0,
},
"opensearch_dashboards": {
"enabled": False,
"max_old_space_size": 0,
"multiple_data_source_enabled": False,
"opensearch_request_timeout": 0,
},
"opensearch_version": "string",
"private_access": {
"opensearch": False,
"opensearch_dashboards": False,
"prometheus": False,
},
"privatelink_access": {
"opensearch": False,
"opensearch_dashboards": False,
"prometheus": False,
},
"project_to_fork_from": "string",
"public_access": {
"opensearch": False,
"opensearch_dashboards": False,
"prometheus": False,
},
"recovery_basebackup_name": "string",
"s3_migration": {
"indices": "string",
"base_path": "string",
"bucket": "string",
"access_key": "string",
"snapshot_name": "string",
"secret_key": "string",
"region": "string",
"chunk_size": "string",
"readonly": False,
"include_aliases": False,
"restore_global_state": False,
"endpoint": "string",
"server_side_encryption": False,
"compress": False,
},
"saml": {
"enabled": False,
"idp_entity_id": "string",
"idp_metadata_url": "string",
"sp_entity_id": "string",
"idp_pemtrustedcas_content": "string",
"roles_key": "string",
"subject_key": "string",
},
"service_log": False,
"service_to_fork_from": "string",
"static_ips": False,
},
opensearches=[{
"opensearch_dashboards_uri": "string",
"password": "string",
"uris": ["string"],
"username": "string",
}],
maintenance_window_dow="string",
project_vpc_id="string",
service_integrations=[{
"integration_type": "string",
"source_service_name": "string",
}],
cloud_name="string",
static_ips=["string"],
tags=[{
"key": "string",
"value": "string",
}],
tech_emails=[{
"email": "string",
}],
termination_protection=False)
const openSearchResource = new aiven.OpenSearch("openSearchResource", {
plan: "string",
serviceName: "string",
project: "string",
maintenanceWindowTime: "string",
additionalDiskSpace: "string",
opensearchUserConfig: {
additionalBackupRegions: "string",
azureMigration: {
account: "string",
basePath: "string",
snapshotName: "string",
indices: "string",
container: "string",
includeAliases: false,
endpointSuffix: "string",
compress: false,
key: "string",
readonly: false,
restoreGlobalState: false,
sasToken: "string",
chunkSize: "string",
},
customDomain: "string",
disableReplicationFactorAdjustment: false,
gcsMigration: {
basePath: "string",
bucket: "string",
credentials: "string",
indices: "string",
snapshotName: "string",
chunkSize: "string",
compress: false,
includeAliases: false,
readonly: false,
restoreGlobalState: false,
},
indexPatterns: [{
maxIndexCount: 0,
pattern: "string",
sortingAlgorithm: "string",
}],
indexRollup: {
rollupDashboardsEnabled: false,
rollupEnabled: false,
rollupSearchBackoffCount: 0,
rollupSearchBackoffMillis: 0,
rollupSearchSearchAllJobs: false,
},
indexTemplate: {
mappingNestedObjectsLimit: 0,
numberOfReplicas: 0,
numberOfShards: 0,
},
ipFilterObjects: [{
network: "string",
description: "string",
}],
ipFilterStrings: ["string"],
keepIndexRefreshInterval: false,
maxIndexCount: 0,
openid: {
clientId: "string",
clientSecret: "string",
connectUrl: "string",
enabled: false,
header: "string",
jwtHeader: "string",
jwtUrlParameter: "string",
refreshRateLimitCount: 0,
refreshRateLimitTimeWindowMs: 0,
rolesKey: "string",
scope: "string",
subjectKey: "string",
},
opensearch: {
actionAutoCreateIndexEnabled: false,
actionDestructiveRequiresName: false,
authFailureListeners: {
internalAuthenticationBackendLimiting: {
allowedTries: 0,
authenticationBackend: "string",
blockExpirySeconds: 0,
maxBlockedClients: 0,
maxTrackedClients: 0,
timeWindowSeconds: 0,
type: "string",
},
},
clusterFilecacheRemoteDataRatio: 0,
clusterMaxShardsPerNode: 0,
clusterRemoteStore: {
stateGlobalMetadataUploadTimeout: "string",
stateMetadataManifestUploadTimeout: "string",
translogBufferInterval: "string",
translogMaxReaders: 0,
},
clusterRoutingAllocationBalancePreferPrimary: false,
clusterRoutingAllocationNodeConcurrentRecoveries: 0,
clusterSearchRequestSlowlog: {
level: "string",
threshold: {
debug: "string",
info: "string",
trace: "string",
warn: "string",
},
},
diskWatermarks: {
floodStage: 0,
high: 0,
low: 0,
},
emailSenderName: "string",
emailSenderPassword: "string",
emailSenderUsername: "string",
enableRemoteBackedStorage: false,
enableSearchableSnapshots: false,
enableSecurityAudit: false,
enableSnapshotApi: false,
httpMaxContentLength: 0,
httpMaxHeaderSize: 0,
httpMaxInitialLineLength: 0,
indicesFielddataCacheSize: 0,
indicesMemoryIndexBufferSize: 0,
indicesMemoryMaxIndexBufferSize: 0,
indicesMemoryMinIndexBufferSize: 0,
indicesQueriesCacheSize: 0,
indicesQueryBoolMaxClauseCount: 0,
indicesRecoveryMaxBytesPerSec: 0,
indicesRecoveryMaxConcurrentFileChunks: 0,
ismEnabled: false,
ismHistoryEnabled: false,
ismHistoryMaxAge: 0,
ismHistoryMaxDocs: 0,
ismHistoryRolloverCheckPeriod: 0,
ismHistoryRolloverRetentionPeriod: 0,
knnMemoryCircuitBreakerEnabled: false,
knnMemoryCircuitBreakerLimit: 0,
nodeSearchCacheSize: "string",
overrideMainResponseVersion: false,
pluginsAlertingFilterByBackendRoles: false,
reindexRemoteWhitelists: ["string"],
remoteStore: {
segmentPressureBytesLagVarianceFactor: 0,
segmentPressureConsecutiveFailuresLimit: 0,
segmentPressureEnabled: false,
segmentPressureTimeLagVarianceFactor: 0,
},
scriptMaxCompilationsRate: "string",
searchBackpressure: {
mode: "string",
nodeDuress: {
cpuThreshold: 0,
heapThreshold: 0,
numSuccessiveBreaches: 0,
},
searchShardTask: {
cancellationBurst: 0,
cancellationRate: 0,
cancellationRatio: 0,
cpuTimeMillisThreshold: 0,
elapsedTimeMillisThreshold: 0,
heapMovingAverageWindowSize: 0,
heapPercentThreshold: 0,
heapVariance: 0,
totalHeapPercentThreshold: 0,
},
searchTask: {
cancellationBurst: 0,
cancellationRate: 0,
cancellationRatio: 0,
cpuTimeMillisThreshold: 0,
elapsedTimeMillisThreshold: 0,
heapMovingAverageWindowSize: 0,
heapPercentThreshold: 0,
heapVariance: 0,
totalHeapPercentThreshold: 0,
},
},
searchInsightsTopQueries: {
cpu: {
enabled: false,
topNSize: 0,
windowSize: "string",
},
latency: {
enabled: false,
topNSize: 0,
windowSize: "string",
},
memory: {
enabled: false,
topNSize: 0,
windowSize: "string",
},
},
searchMaxBuckets: 0,
segrep: {
pressureCheckpointLimit: 0,
pressureEnabled: false,
pressureReplicaStaleLimit: 0,
pressureTimeLimit: "string",
},
shardIndexingPressure: {
enabled: false,
enforced: false,
operatingFactor: {
lower: 0,
optimal: 0,
upper: 0,
},
primaryParameter: {
node: {
softLimit: 0,
},
shard: {
minLimit: 0,
},
},
},
threadPoolAnalyzeQueueSize: 0,
threadPoolAnalyzeSize: 0,
threadPoolForceMergeSize: 0,
threadPoolGetQueueSize: 0,
threadPoolGetSize: 0,
threadPoolSearchQueueSize: 0,
threadPoolSearchSize: 0,
threadPoolSearchThrottledQueueSize: 0,
threadPoolSearchThrottledSize: 0,
threadPoolWriteQueueSize: 0,
threadPoolWriteSize: 0,
},
opensearchDashboards: {
enabled: false,
maxOldSpaceSize: 0,
multipleDataSourceEnabled: false,
opensearchRequestTimeout: 0,
},
opensearchVersion: "string",
privateAccess: {
opensearch: false,
opensearchDashboards: false,
prometheus: false,
},
privatelinkAccess: {
opensearch: false,
opensearchDashboards: false,
prometheus: false,
},
projectToForkFrom: "string",
publicAccess: {
opensearch: false,
opensearchDashboards: false,
prometheus: false,
},
recoveryBasebackupName: "string",
s3Migration: {
indices: "string",
basePath: "string",
bucket: "string",
accessKey: "string",
snapshotName: "string",
secretKey: "string",
region: "string",
chunkSize: "string",
readonly: false,
includeAliases: false,
restoreGlobalState: false,
endpoint: "string",
serverSideEncryption: false,
compress: false,
},
saml: {
enabled: false,
idpEntityId: "string",
idpMetadataUrl: "string",
spEntityId: "string",
idpPemtrustedcasContent: "string",
rolesKey: "string",
subjectKey: "string",
},
serviceLog: false,
serviceToForkFrom: "string",
staticIps: false,
},
opensearches: [{
opensearchDashboardsUri: "string",
password: "string",
uris: ["string"],
username: "string",
}],
maintenanceWindowDow: "string",
projectVpcId: "string",
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cloudName: "string",
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
techEmails: [{
email: "string",
}],
terminationProtection: false,
});
type: aiven:OpenSearch
properties:
additionalDiskSpace: string
cloudName: string
maintenanceWindowDow: string
maintenanceWindowTime: string
opensearchUserConfig:
additionalBackupRegions: string
azureMigration:
account: string
basePath: string
chunkSize: string
compress: false
container: string
endpointSuffix: string
includeAliases: false
indices: string
key: string
readonly: false
restoreGlobalState: false
sasToken: string
snapshotName: string
customDomain: string
disableReplicationFactorAdjustment: false
gcsMigration:
basePath: string
bucket: string
chunkSize: string
compress: false
credentials: string
includeAliases: false
indices: string
readonly: false
restoreGlobalState: false
snapshotName: string
indexPatterns:
- maxIndexCount: 0
pattern: string
sortingAlgorithm: string
indexRollup:
rollupDashboardsEnabled: false
rollupEnabled: false
rollupSearchBackoffCount: 0
rollupSearchBackoffMillis: 0
rollupSearchSearchAllJobs: false
indexTemplate:
mappingNestedObjectsLimit: 0
numberOfReplicas: 0
numberOfShards: 0
ipFilterObjects:
- description: string
network: string
ipFilterStrings:
- string
keepIndexRefreshInterval: false
maxIndexCount: 0
openid:
clientId: string
clientSecret: string
connectUrl: string
enabled: false
header: string
jwtHeader: string
jwtUrlParameter: string
refreshRateLimitCount: 0
refreshRateLimitTimeWindowMs: 0
rolesKey: string
scope: string
subjectKey: string
opensearch:
actionAutoCreateIndexEnabled: false
actionDestructiveRequiresName: false
authFailureListeners:
internalAuthenticationBackendLimiting:
allowedTries: 0
authenticationBackend: string
blockExpirySeconds: 0
maxBlockedClients: 0
maxTrackedClients: 0
timeWindowSeconds: 0
type: string
clusterFilecacheRemoteDataRatio: 0
clusterMaxShardsPerNode: 0
clusterRemoteStore:
stateGlobalMetadataUploadTimeout: string
stateMetadataManifestUploadTimeout: string
translogBufferInterval: string
translogMaxReaders: 0
clusterRoutingAllocationBalancePreferPrimary: false
clusterRoutingAllocationNodeConcurrentRecoveries: 0
clusterSearchRequestSlowlog:
level: string
threshold:
debug: string
info: string
trace: string
warn: string
diskWatermarks:
floodStage: 0
high: 0
low: 0
emailSenderName: string
emailSenderPassword: string
emailSenderUsername: string
enableRemoteBackedStorage: false
enableSearchableSnapshots: false
enableSecurityAudit: false
enableSnapshotApi: false
httpMaxContentLength: 0
httpMaxHeaderSize: 0
httpMaxInitialLineLength: 0
indicesFielddataCacheSize: 0
indicesMemoryIndexBufferSize: 0
indicesMemoryMaxIndexBufferSize: 0
indicesMemoryMinIndexBufferSize: 0
indicesQueriesCacheSize: 0
indicesQueryBoolMaxClauseCount: 0
indicesRecoveryMaxBytesPerSec: 0
indicesRecoveryMaxConcurrentFileChunks: 0
ismEnabled: false
ismHistoryEnabled: false
ismHistoryMaxAge: 0
ismHistoryMaxDocs: 0
ismHistoryRolloverCheckPeriod: 0
ismHistoryRolloverRetentionPeriod: 0
knnMemoryCircuitBreakerEnabled: false
knnMemoryCircuitBreakerLimit: 0
nodeSearchCacheSize: string
overrideMainResponseVersion: false
pluginsAlertingFilterByBackendRoles: false
reindexRemoteWhitelists:
- string
remoteStore:
segmentPressureBytesLagVarianceFactor: 0
segmentPressureConsecutiveFailuresLimit: 0
segmentPressureEnabled: false
segmentPressureTimeLagVarianceFactor: 0
scriptMaxCompilationsRate: string
searchBackpressure:
mode: string
nodeDuress:
cpuThreshold: 0
heapThreshold: 0
numSuccessiveBreaches: 0
searchShardTask:
cancellationBurst: 0
cancellationRate: 0
cancellationRatio: 0
cpuTimeMillisThreshold: 0
elapsedTimeMillisThreshold: 0
heapMovingAverageWindowSize: 0
heapPercentThreshold: 0
heapVariance: 0
totalHeapPercentThreshold: 0
searchTask:
cancellationBurst: 0
cancellationRate: 0
cancellationRatio: 0
cpuTimeMillisThreshold: 0
elapsedTimeMillisThreshold: 0
heapMovingAverageWindowSize: 0
heapPercentThreshold: 0
heapVariance: 0
totalHeapPercentThreshold: 0
searchInsightsTopQueries:
cpu:
enabled: false
topNSize: 0
windowSize: string
latency:
enabled: false
topNSize: 0
windowSize: string
memory:
enabled: false
topNSize: 0
windowSize: string
searchMaxBuckets: 0
segrep:
pressureCheckpointLimit: 0
pressureEnabled: false
pressureReplicaStaleLimit: 0
pressureTimeLimit: string
shardIndexingPressure:
enabled: false
enforced: false
operatingFactor:
lower: 0
optimal: 0
upper: 0
primaryParameter:
node:
softLimit: 0
shard:
minLimit: 0
threadPoolAnalyzeQueueSize: 0
threadPoolAnalyzeSize: 0
threadPoolForceMergeSize: 0
threadPoolGetQueueSize: 0
threadPoolGetSize: 0
threadPoolSearchQueueSize: 0
threadPoolSearchSize: 0
threadPoolSearchThrottledQueueSize: 0
threadPoolSearchThrottledSize: 0
threadPoolWriteQueueSize: 0
threadPoolWriteSize: 0
opensearchDashboards:
enabled: false
maxOldSpaceSize: 0
multipleDataSourceEnabled: false
opensearchRequestTimeout: 0
opensearchVersion: string
privateAccess:
opensearch: false
opensearchDashboards: false
prometheus: false
privatelinkAccess:
opensearch: false
opensearchDashboards: false
prometheus: false
projectToForkFrom: string
publicAccess:
opensearch: false
opensearchDashboards: false
prometheus: false
recoveryBasebackupName: string
s3Migration:
accessKey: string
basePath: string
bucket: string
chunkSize: string
compress: false
endpoint: string
includeAliases: false
indices: string
readonly: false
region: string
restoreGlobalState: false
secretKey: string
serverSideEncryption: false
snapshotName: string
saml:
enabled: false
idpEntityId: string
idpMetadataUrl: string
idpPemtrustedcasContent: string
rolesKey: string
spEntityId: string
subjectKey: string
serviceLog: false
serviceToForkFrom: string
staticIps: false
opensearches:
- opensearchDashboardsUri: string
password: string
uris:
- string
username: string
plan: string
project: string
projectVpcId: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
techEmails:
- email: string
terminationProtection: false
OpenSearch Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OpenSearch resource accepts the following input properties:
- 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-xandpremium-xwherexis (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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 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. - Disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User OpenConfig Search Opensearch User Config - 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<Open
Search Opensearch> - Values provided by the OpenSearch server.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- Service
Integrations List<OpenSearch Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips 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
-
List<Open
Search Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<OpenSearch Tech Email> - 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
truefor 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.
- 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-xandpremium-xwherexis (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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 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. - Disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User OpenConfig Search Opensearch User Config Args - 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
[]Open
Search Opensearch Args - Values provided by the OpenSearch server.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- Service
Integrations []OpenSearch Service Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []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
-
[]Open
Search Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []OpenSearch Tech Email Args - 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
truefor 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.
- 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-xandpremium-xwherexis (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.
- service
Name 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.
- additional
Disk StringSpace - 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 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. - disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User OpenConfig Search Opensearch User Config - 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<Open
Search Opensearch> - Values provided by the OpenSearch server.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Integrations List<OpenSearch Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
-
List<Open
Search Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<OpenSearch Tech Email> - 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 Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- 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-xandpremium-xwherexis (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.
- service
Name 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.
- additional
Disk stringSpace - 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 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. - disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User OpenConfig Search Opensearch User Config - 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
Open
Search Opensearch[] - Values provided by the OpenSearch server.
- project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Integrations OpenSearch Service Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
-
Open
Search Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails OpenSearch Tech Email[] - 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 boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
- 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-xandpremium-xwherexis (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.
- 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.
- additional_
disk_ strspace - 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. - 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch_
user_ Openconfig Search Opensearch User Config Args - 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[Open
Search Opensearch Args] - Values provided by the OpenSearch server.
- project_
vpc_ strid - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service_
integrations Sequence[OpenSearch Service Integration Args] - Service integrations to specify when creating a service. Not applied after initial service creation
- 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
-
Sequence[Open
Search Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[OpenSearch Tech Email Args] - 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
truefor 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.
- 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-xandpremium-xwherexis (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.
- service
Name 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.
- additional
Disk StringSpace - 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 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. - disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User Property MapConfig - 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>
- Values provided by the OpenSearch server.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the OpenSearch resource produces the following output properties:
- Components
List<Open
Search Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - Id string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Window boolEnabled - Indicates whether the maintenance window is currently enabled for this service.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Components
[]Open
Search Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - Id string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Window boolEnabled - Indicates whether the maintenance window is currently enabled for this service.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- components
List<Open
Search Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - id String
- The provider-assigned unique ID for this managed resource.
- maintenance
Window BooleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- components
Open
Search Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - id string
- The provider-assigned unique ID for this managed resource.
- maintenance
Window booleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- components
Sequence[Open
Search Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk_
space_ strused - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - id str
- The provider-assigned unique ID for this managed resource.
- maintenance_
window_ boolenabled - Indicates whether the maintenance window is currently enabled for this service.
- service_
host str - The hostname of the service.
- 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
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - id String
- The provider-assigned unique ID for this managed resource.
- maintenance
Window BooleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
Look up Existing OpenSearch Resource
Get an existing OpenSearch resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OpenSearchState, opts?: CustomResourceOptions): OpenSearch@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_disk_space: Optional[str] = None,
cloud_name: Optional[str] = None,
components: Optional[Sequence[OpenSearchComponentArgs]] = None,
disk_space: Optional[str] = None,
disk_space_cap: Optional[str] = None,
disk_space_default: Optional[str] = None,
disk_space_step: Optional[str] = None,
disk_space_used: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_enabled: Optional[bool] = None,
maintenance_window_time: Optional[str] = None,
opensearch_user_config: Optional[OpenSearchOpensearchUserConfigArgs] = None,
opensearches: Optional[Sequence[OpenSearchOpensearchArgs]] = None,
plan: Optional[str] = None,
project: Optional[str] = None,
project_vpc_id: Optional[str] = None,
service_host: Optional[str] = None,
service_integrations: Optional[Sequence[OpenSearchServiceIntegrationArgs]] = None,
service_name: Optional[str] = None,
service_password: Optional[str] = None,
service_port: Optional[int] = None,
service_type: Optional[str] = None,
service_uri: Optional[str] = None,
service_username: Optional[str] = None,
state: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[OpenSearchTagArgs]] = None,
tech_emails: Optional[Sequence[OpenSearchTechEmailArgs]] = None,
termination_protection: Optional[bool] = None) -> OpenSearchfunc GetOpenSearch(ctx *Context, name string, id IDInput, state *OpenSearchState, opts ...ResourceOption) (*OpenSearch, error)public static OpenSearch Get(string name, Input<string> id, OpenSearchState? state, CustomResourceOptions? opts = null)public static OpenSearch get(String name, Output<String> id, OpenSearchState state, CustomResourceOptions options)resources: _: type: aiven:OpenSearch get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Disk stringSpace - 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 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<Open
Search Component> - Service component information objects
- Disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window boolEnabled - Indicates whether the maintenance window is currently enabled for this service.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User OpenConfig Search Opensearch User Config - 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<Open
Search Opensearch> - Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- Service
Host string - The hostname of the service.
- Service
Integrations List<OpenSearch Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Static
Ips 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
-
List<Open
Search Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<OpenSearch Tech Email> - 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
truefor 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 stringSpace - 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 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
[]Open
Search Component Args - Service component information objects
- Disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window boolEnabled - Indicates whether the maintenance window is currently enabled for this service.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User OpenConfig Search Opensearch User Config Args - 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
[]Open
Search Opensearch Args - Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- Service
Host string - The hostname of the service.
- Service
Integrations []OpenSearch Service Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Static
Ips []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
-
[]Open
Search Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []OpenSearch Tech Email Args - 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
truefor 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 StringSpace - 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 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<Open
Search Component> - Service component information objects
- disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window BooleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User OpenConfig Search Opensearch User Config - 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<Open
Search Opensearch> - Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Host String - The hostname of the service.
- service
Integrations List<OpenSearch Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- static
Ips 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
-
List<Open
Search Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<OpenSearch Tech Email> - 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 Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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 stringSpace - 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 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
Open
Search Component[] - Service component information objects
- disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space stringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window booleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User OpenConfig Search Opensearch User Config - 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
Open
Search Opensearch[] - Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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.
- project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Host string - The hostname of the service.
- service
Integrations OpenSearch Service Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- static
Ips 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
-
Open
Search Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails OpenSearch Tech Email[] - 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 boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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_ strspace - 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[Open
Search Component Args] - 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk_
space_ strused - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ boolenabled - Indicates whether the maintenance window is currently enabled for this service.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch_
user_ Openconfig Search Opensearch User Config Args - 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[Open
Search Opensearch Args] - Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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_ strid - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a 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[OpenSearch Service Integration Args] - 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
-
Sequence[Open
Search Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[OpenSearch Tech Email Args] - 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
truefor 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 StringSpace - 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 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
- disk
Space 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. Please use
additional_disk_spaceto specify the space to be added to the default disk space defined by the plan. - disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - The disk space that the service is currently using. This is the sum of
disk_spaceandadditional_disk_spacein human-readable format (for example:90GiB). - maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window BooleanEnabled - Indicates whether the maintenance window is currently enabled for this service.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User Property MapConfig - 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>
- Values provided by the OpenSearch server.
- 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-xandpremium-xwherexis (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.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set, the service runs on the Public Internet. 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. The service can be freely moved to and from VPC after creation, but doing so triggers migration to new servers, so the operation can take a significant amount of time to complete if the service has a lot of data.
- service
Host String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor 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
OpenSearchComponent, OpenSearchComponentArgs
- Component string
- Service component name
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_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
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl StringCa - Kafka certificate used. The possible values are
letsencryptandproject_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
- connection
Uri 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
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_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_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka_
ssl_ strca - Kafka certificate used. The possible values are
letsencryptandproject_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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl StringCa - Kafka certificate used. The possible values are
letsencryptandproject_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
OpenSearchOpensearch, OpenSearchOpensearchArgs
- Kibana
Uri string - URI for Kibana dashboard frontend.
- Opensearch
Dashboards stringUri - URI for OpenSearch dashboard frontend.
- Password string
- OpenSearch password.
- Uris List<string>
- OpenSearch server URIs.
- Username string
- OpenSearch username.
- Kibana
Uri string - URI for Kibana dashboard frontend.
- Opensearch
Dashboards stringUri - URI for OpenSearch dashboard frontend.
- Password string
- OpenSearch password.
- Uris []string
- OpenSearch server URIs.
- Username string
- OpenSearch username.
- kibana
Uri String - URI for Kibana dashboard frontend.
- opensearch
Dashboards StringUri - URI for OpenSearch dashboard frontend.
- password String
- OpenSearch password.
- uris List<String>
- OpenSearch server URIs.
- username String
- OpenSearch username.
- kibana
Uri string - URI for Kibana dashboard frontend.
- opensearch
Dashboards stringUri - 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.
- opensearch_
dashboards_ struri - URI for OpenSearch dashboard frontend.
- password str
- OpenSearch password.
- uris Sequence[str]
- OpenSearch server URIs.
- username str
- OpenSearch username.
- kibana
Uri String - URI for Kibana dashboard frontend.
- opensearch
Dashboards StringUri - URI for OpenSearch dashboard frontend.
- password String
- OpenSearch password.
- uris List<String>
- OpenSearch server URIs.
- username String
- OpenSearch username.
OpenSearchOpensearchUserConfig, OpenSearchOpensearchUserConfigArgs
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Azure
Migration OpenSearch Opensearch User Config Azure Migration - Azure migration settings
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - Disable
Replication boolFactor Adjustment - 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 OpenSearch Opensearch User Config Gcs Migration - Google Cloud Storage migration settings
- Index
Patterns List<OpenSearch Opensearch User Config Index Pattern> - Index patterns
- Index
Rollup OpenSearch Opensearch User Config Index Rollup - Index rollup settings
- Index
Template OpenSearch Opensearch User Config Index Template - Template settings for all new indexes
- Ip
Filter List<OpenObjects Search Opensearch User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - Keep
Index boolRefresh Interval - 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 intCount - Use index_patterns instead. Default:
0. - Openid
Open
Search Opensearch User Config Openid - OpenSearch OpenID Connect Configuration
- Opensearch
Open
Search Opensearch User Config Opensearch - OpenSearch settings
- Opensearch
Dashboards OpenSearch Opensearch User Config Opensearch Dashboards - OpenSearch Dashboards settings
- Opensearch
Version string - Enum:
1,2,2.19, and newer. OpenSearch version. - Private
Access OpenSearch Opensearch User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access OpenSearch Opensearch User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - Public
Access OpenSearch Opensearch User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z. - S3Migration
Open
Search Opensearch User Config S3Migration - AWS S3 / AWS S3 compatible migration settings
- Saml
Open
Search Opensearch User Config Saml - OpenSearch SAML configuration
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Service
To stringFork From - 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.
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Azure
Migration OpenSearch Opensearch User Config Azure Migration - Azure migration settings
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - Disable
Replication boolFactor Adjustment - 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 OpenSearch Opensearch User Config Gcs Migration - Google Cloud Storage migration settings
- Index
Patterns []OpenSearch Opensearch User Config Index Pattern - Index patterns
- Index
Rollup OpenSearch Opensearch User Config Index Rollup - Index rollup settings
- Index
Template OpenSearch Opensearch User Config Index Template - Template settings for all new indexes
- Ip
Filter []OpenObjects Search Opensearch User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - Keep
Index boolRefresh Interval - 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 intCount - Use index_patterns instead. Default:
0. - Openid
Open
Search Opensearch User Config Openid - OpenSearch OpenID Connect Configuration
- Opensearch
Open
Search Opensearch User Config Opensearch - OpenSearch settings
- Opensearch
Dashboards OpenSearch Opensearch User Config Opensearch Dashboards - OpenSearch Dashboards settings
- Opensearch
Version string - Enum:
1,2,2.19, and newer. OpenSearch version. - Private
Access OpenSearch Opensearch User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access OpenSearch Opensearch User Config Privatelink Access - Allow access to selected service components through Privatelink
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - Public
Access OpenSearch Opensearch User Config Public Access - Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z. - S3Migration
Open
Search Opensearch User Config S3Migration - AWS S3 / AWS S3 compatible migration settings
- Saml
Open
Search Opensearch User Config Saml - OpenSearch SAML configuration
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Service
To stringFork From - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- azure
Migration OpenSearch Opensearch User Config Azure Migration - Azure migration settings
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - disable
Replication BooleanFactor Adjustment - 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 OpenSearch Opensearch User Config Gcs Migration - Google Cloud Storage migration settings
- index
Patterns List<OpenSearch Opensearch User Config Index Pattern> - Index patterns
- index
Rollup OpenSearch Opensearch User Config Index Rollup - Index rollup settings
- index
Template OpenSearch Opensearch User Config Index Template - Template settings for all new indexes
- ip
Filter List<OpenObjects Search Opensearch User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - keep
Index BooleanRefresh Interval - 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 IntegerCount - Use index_patterns instead. Default:
0. - openid
Open
Search Opensearch User Config Openid - OpenSearch OpenID Connect Configuration
- opensearch
Open
Search Opensearch User Config Opensearch - OpenSearch settings
- opensearch
Dashboards OpenSearch Opensearch User Config Opensearch Dashboards - OpenSearch Dashboards settings
- opensearch
Version String - Enum:
1,2,2.19, and newer. OpenSearch version. - private
Access OpenSearch Opensearch User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access OpenSearch Opensearch User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - public
Access OpenSearch Opensearch User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z. - s3Migration
Open
Search Opensearch User Config S3Migration - AWS S3 / AWS S3 compatible migration settings
- saml
Open
Search Opensearch User Config Saml - OpenSearch SAML configuration
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename. - static
Ips Boolean - Use static public IP addresses.
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- azure
Migration OpenSearch Opensearch User Config Azure Migration - Azure migration settings
- custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - disable
Replication booleanFactor Adjustment - 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 OpenSearch Opensearch User Config Gcs Migration - Google Cloud Storage migration settings
- index
Patterns OpenSearch Opensearch User Config Index Pattern[] - Index patterns
- index
Rollup OpenSearch Opensearch User Config Index Rollup - Index rollup settings
- index
Template OpenSearch Opensearch User Config Index Template - Template settings for all new indexes
- ip
Filter OpenObjects Search Opensearch User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - keep
Index booleanRefresh Interval - 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 numberCount - Use index_patterns instead. Default:
0. - openid
Open
Search Opensearch User Config Openid - OpenSearch OpenID Connect Configuration
- opensearch
Open
Search Opensearch User Config Opensearch - OpenSearch settings
- opensearch
Dashboards OpenSearch Opensearch User Config Opensearch Dashboards - OpenSearch Dashboards settings
- opensearch
Version string - Enum:
1,2,2.19, and newer. OpenSearch version. - private
Access OpenSearch Opensearch User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access OpenSearch Opensearch User Config Privatelink Access - Allow access to selected service components through Privatelink
- project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - public
Access OpenSearch Opensearch User Config Public Access - Allow access to selected service ports from the public Internet
- recovery
Basebackup stringName - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z. - s3Migration
Open
Search Opensearch User Config S3Migration - AWS S3 / AWS S3 compatible migration settings
- saml
Open
Search Opensearch User Config Saml - OpenSearch SAML configuration
- service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename. - static
Ips boolean - Use static public IP addresses.
- additional_
backup_ strregions - Additional Cloud Regions for Backup Replication.
- azure_
migration OpenSearch Opensearch User Config Azure Migration - 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_ boolfactor_ adjustment - 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 OpenSearch Opensearch User Config Gcs Migration - Google Cloud Storage migration settings
- index_
patterns Sequence[OpenSearch Opensearch User Config Index Pattern] - Index patterns
- index_
rollup OpenSearch Opensearch User Config Index Rollup - Index rollup settings
- index_
template OpenSearch Opensearch User Config Index Template - Template settings for all new indexes
- ip_
filter_ Sequence[Openobjects Search Opensearch User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip_
filter_ Sequence[str]strings - 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. - keep_
index_ boolrefresh_ interval - 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_ intcount - Use index_patterns instead. Default:
0. - openid
Open
Search Opensearch User Config Openid - OpenSearch OpenID Connect Configuration
- opensearch
Open
Search Opensearch User Config Opensearch - OpenSearch settings
- opensearch_
dashboards OpenSearch Opensearch User Config Opensearch Dashboards - OpenSearch Dashboards settings
- opensearch_
version str - Enum:
1,2,2.19, and newer. OpenSearch version. - private_
access OpenSearch Opensearch User Config Private Access - Allow access to selected service ports from private networks
- privatelink_
access OpenSearch Opensearch User Config Privatelink Access - Allow access to selected service components through Privatelink
- project_
to_ strfork_ from - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - public_
access OpenSearch Opensearch User Config Public Access - Allow access to selected service ports from the public Internet
- recovery_
basebackup_ strname - Name of the basebackup to restore in forked service. Example:
backup-20191112t091354293891z. - s3_
migration OpenSearch Opensearch User Config S3Migration - AWS S3 / AWS S3 compatible migration settings
- saml
Open
Search Opensearch User Config Saml - OpenSearch SAML configuration
- service_
log bool - Store logs for the service so that they are available in the HTTP API and console.
- service_
to_ strfork_ from - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- azure
Migration Property Map - Azure migration settings
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - disable
Replication BooleanFactor Adjustment - 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 Property Map - Google Cloud Storage migration settings
- index
Patterns List<Property Map> - Index patterns
- index
Rollup Property Map - Index rollup settings
- index
Template Property Map - Template settings for all new indexes
- ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16. - keep
Index BooleanRefresh Interval - 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 NumberCount - Use index_patterns instead. Default:
0. - openid Property Map
- OpenSearch OpenID Connect Configuration
- opensearch Property Map
- OpenSearch settings
- opensearch
Dashboards Property Map - OpenSearch Dashboards settings
- opensearch
Version String - Enum:
1,2,2.19, and newer. OpenSearch version. - private
Access Property Map - Allow access to selected service ports from private networks
- privatelink
Access Property Map - Allow access to selected service components through Privatelink
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname. - public
Access Property Map - Allow access to selected service ports from the public Internet
- recovery
Basebackup StringName - 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
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename. - static
Ips Boolean - Use static public IP addresses.
OpenSearchOpensearchUserConfigAzureMigration, OpenSearchOpensearchUserConfigAzureMigrationArgs
- Account string
- Account name.
- Base
Path 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. - Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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
Suffix string - Defines the DNS suffix for Azure Storage endpoints.
- Include
Aliases 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. - Restore
Global boolState - If true, restore the cluster state. Defaults to false.
- Sas
Token string - A shared access signatures (SAS) token. One of key or sas_token should be specified.
- Account string
- Account name.
- Base
Path 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. - Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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
Suffix string - Defines the DNS suffix for Azure Storage endpoints.
- Include
Aliases 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. - Restore
Global boolState - If true, restore the cluster state. Defaults to false.
- Sas
Token string - A shared access signatures (SAS) token. One of key or sas_token should be specified.
- account String
- Account name.
- base
Path 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. - snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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
Suffix String - Defines the DNS suffix for Azure Storage endpoints.
- include
Aliases 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. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
- sas
Token String - A shared access signatures (SAS) token. One of key or sas_token should be specified.
- account string
- Account name.
- base
Path 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. - snapshot
Name string - The snapshot name to restore from.
- chunk
Size 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
Suffix string - Defines the DNS suffix for Azure Storage endpoints.
- include
Aliases 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. - restore
Global booleanState - If true, restore the cluster state. Defaults to false.
- sas
Token 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_ boolstate - 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.
- base
Path 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. - snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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
Suffix String - Defines the DNS suffix for Azure Storage endpoints.
- include
Aliases 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. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
- sas
Token String - A shared access signatures (SAS) token. One of key or sas_token should be specified.
OpenSearchOpensearchUserConfigGcsMigration, OpenSearchOpensearchUserConfigGcsMigrationArgs
- Base
Path 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. - Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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.
- 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 boolState - If true, restore the cluster state. Defaults to false.
- Base
Path 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. - Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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.
- 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 boolState - If true, restore the cluster state. Defaults to false.
- base
Path 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. - snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases Boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly Boolean
- Whether the repository is read-only. Default:
true. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
- base
Path 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. - snapshot
Name string - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly boolean
- Whether the repository is read-only. Default:
true. - restore
Global booleanState - 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_ boolstate - If true, restore the cluster state. Defaults to false.
- base
Path 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. - snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases Boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly Boolean
- Whether the repository is read-only. Default:
true. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
OpenSearchOpensearchUserConfigIndexPattern, OpenSearchOpensearchUserConfigIndexPatternArgs
- Max
Index intCount - Maximum number of indexes to keep. Example:
3. - Pattern string
- fnmatch pattern. Example:
logs_*_foo_*. - Sorting
Algorithm string - Enum:
alphabetical,creation_date. Deletion sorting algorithm. Default:creation_date.
- Max
Index intCount - Maximum number of indexes to keep. Example:
3. - Pattern string
- fnmatch pattern. Example:
logs_*_foo_*. - Sorting
Algorithm string - Enum:
alphabetical,creation_date. Deletion sorting algorithm. Default:creation_date.
- max
Index IntegerCount - Maximum number of indexes to keep. Example:
3. - pattern String
- fnmatch pattern. Example:
logs_*_foo_*. - sorting
Algorithm String - Enum:
alphabetical,creation_date. Deletion sorting algorithm. Default:creation_date.
- max
Index numberCount - Maximum number of indexes to keep. Example:
3. - pattern string
- fnmatch pattern. Example:
logs_*_foo_*. - sorting
Algorithm string - Enum:
alphabetical,creation_date. Deletion sorting algorithm. Default:creation_date.
- max_
index_ intcount - 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.
- max
Index NumberCount - Maximum number of indexes to keep. Example:
3. - pattern String
- fnmatch pattern. Example:
logs_*_foo_*. - sorting
Algorithm String - Enum:
alphabetical,creation_date. Deletion sorting algorithm. Default:creation_date.
OpenSearchOpensearchUserConfigIndexRollup, OpenSearchOpensearchUserConfigIndexRollupArgs
- Rollup
Dashboards boolEnabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- Rollup
Enabled bool - Whether the rollup plugin is enabled. Defaults to true.
- Rollup
Search intBackoff Count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- Rollup
Search intBackoff Millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- Rollup
Search boolSearch All Jobs - 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 boolEnabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- Rollup
Enabled bool - Whether the rollup plugin is enabled. Defaults to true.
- Rollup
Search intBackoff Count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- Rollup
Search intBackoff Millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- Rollup
Search boolSearch All Jobs - 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 BooleanEnabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- rollup
Enabled Boolean - Whether the rollup plugin is enabled. Defaults to true.
- rollup
Search IntegerBackoff Count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- rollup
Search IntegerBackoff Millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- rollup
Search BooleanSearch All Jobs - 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 booleanEnabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- rollup
Enabled boolean - Whether the rollup plugin is enabled. Defaults to true.
- rollup
Search numberBackoff Count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- rollup
Search numberBackoff Millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- rollup
Search booleanSearch All Jobs - 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_ boolenabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- rollup_
enabled bool - Whether the rollup plugin is enabled. Defaults to true.
- rollup_
search_ intbackoff_ count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- rollup_
search_ intbackoff_ millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- rollup_
search_ boolsearch_ all_ jobs - 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 BooleanEnabled - Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.
- rollup
Enabled Boolean - Whether the rollup plugin is enabled. Defaults to true.
- rollup
Search NumberBackoff Count - How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.
- rollup
Search NumberBackoff Millis - The backoff time between retries for failed rollup jobs. Defaults to 1000ms.
- rollup
Search BooleanSearch All Jobs - 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.
OpenSearchOpensearchUserConfigIndexTemplate, OpenSearchOpensearchUserConfigIndexTemplateArgs
- Mapping
Nested intObjects Limit - 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. Deprecated, use an index template instead. Example:
10000. - Number
Of intReplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - Number
Of intShards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
- Mapping
Nested intObjects Limit - 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. Deprecated, use an index template instead. Example:
10000. - Number
Of intReplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - Number
Of intShards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
- mapping
Nested IntegerObjects Limit - 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. Deprecated, use an index template instead. Example:
10000. - number
Of IntegerReplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - number
Of IntegerShards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
- mapping
Nested numberObjects Limit - 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. Deprecated, use an index template instead. Example:
10000. - number
Of numberReplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - number
Of numberShards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
- mapping_
nested_ intobjects_ limit - 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. Deprecated, use an index template instead. Example:
10000. - number_
of_ intreplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - number_
of_ intshards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
- mapping
Nested NumberObjects Limit - 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. Deprecated, use an index template instead. Example:
10000. - number
Of NumberReplicas - The number of replicas each primary shard has. Deprecated, use an index template instead. Example:
1. - number
Of NumberShards - The number of primary shards that an index should have. Deprecated, use an index template instead. Example:
1.
OpenSearchOpensearchUserConfigIpFilterObject, OpenSearchOpensearchUserConfigIpFilterObjectArgs
- 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.
OpenSearchOpensearchUserConfigOpenid, OpenSearchOpensearchUserConfigOpenidArgs
- Client
Id string - The ID of the OpenID Connect client configured in your IdP. Required.
- Client
Secret string - The client secret of the OpenID Connect client configured in your IdP. Required.
- Connect
Url 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. - Jwt
Header string - The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization. Example:
preferred_username. - Jwt
Url stringParameter - 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 intLimit Count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - Refresh
Rate intLimit Time Window Ms - 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 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.
- Subject
Key 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 string - The ID of the OpenID Connect client configured in your IdP. Required.
- Client
Secret string - The client secret of the OpenID Connect client configured in your IdP. Required.
- Connect
Url 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. - Jwt
Header string - The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization. Example:
preferred_username. - Jwt
Url stringParameter - 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 intLimit Count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - Refresh
Rate intLimit Time Window Ms - 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 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.
- Subject
Key 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 String - The ID of the OpenID Connect client configured in your IdP. Required.
- client
Secret String - The client secret of the OpenID Connect client configured in your IdP. Required.
- connect
Url 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. - jwt
Header String - The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization. Example:
preferred_username. - jwt
Url StringParameter - 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 IntegerLimit Count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - refresh
Rate IntegerLimit Time Window Ms - 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 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.
- subject
Key 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 string - The ID of the OpenID Connect client configured in your IdP. Required.
- client
Secret string - The client secret of the OpenID Connect client configured in your IdP. Required.
- connect
Url 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. - jwt
Header string - The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization. Example:
preferred_username. - jwt
Url stringParameter - 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 numberLimit Count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - refresh
Rate numberLimit Time Window Ms - 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 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.
- subject
Key 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 \n\n. Optional. Default is Authorization. Example:
preferred_username. - jwt_
url_ strparameter - 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_ intlimit_ count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - refresh_
rate_ intlimit_ time_ window_ ms - 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.
- client
Id String - The ID of the OpenID Connect client configured in your IdP. Required.
- client
Secret String - The client secret of the OpenID Connect client configured in your IdP. Required.
- connect
Url 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. - jwt
Header String - The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization. Example:
preferred_username. - jwt
Url StringParameter - 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 NumberLimit Count - The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default:
10. - refresh
Rate NumberLimit Time Window Ms - 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 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.
- subject
Key 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.
OpenSearchOpensearchUserConfigOpensearch, OpenSearchOpensearchUserConfigOpensearchArgs
- Action
Auto boolCreate Index Enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- Action
Destructive boolRequires Name - Require explicit index names when deleting.
- Auth
Failure OpenListeners Search Opensearch User Config Opensearch Auth Failure Listeners - Opensearch Security Plugin Settings
- Cluster
Filecache doubleRemote Data Ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- Cluster
Max intShards Per Node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - Cluster
Remote OpenStore Search Opensearch User Config Opensearch Cluster Remote Store - Cluster
Routing boolAllocation Balance Prefer Primary - 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.
- Cluster
Routing intAllocation Node Concurrent Recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- Cluster
Search OpenRequest Slowlog Search Opensearch User Config Opensearch Cluster Search Request Slowlog - Disk
Watermarks OpenSearch Opensearch User Config Opensearch Disk Watermarks - Watermark settings
- Email
Sender stringName - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - Email
Sender stringPassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - Email
Sender stringUsername - Sender username for Opensearch alerts. Example:
jane@example.com. - Enable
Remote boolBacked Storage - Enable remote-backed storage.
- Enable
Searchable boolSnapshots - Enable searchable snapshots.
- Enable
Security boolAudit - Enable/Disable security audit.
- Enable
Snapshot boolApi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- Http
Max intContent Length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- Http
Max intHeader Size - The max size of allowed headers, in bytes. Example:
8192. - Http
Max intInitial Line Length - The max length of an HTTP URL, in bytes. Example:
4096. - Indices
Fielddata intCache Size - 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 intIndex Buffer Size - 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 intMax Index Buffer Size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- Indices
Memory intMin Index Buffer Size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- Indices
Queries intCache Size - 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 intBool Max Clause Count - 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 intMax Bytes Per Sec - 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 intMax Concurrent File Chunks - 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 boolEnabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- Ism
History intMax Age - The maximum age before rolling over the audit history index in hours. Example:
24. - Ism
History intMax Docs - The maximum number of documents before rolling over the audit history index.
- Ism
History intRollover Check Period - The time between rollover checks for the audit history index in hours. Example:
8. - Ism
History intRollover Retention Period - How long audit history indices are kept in days. Example:
30. - Knn
Memory boolCircuit Breaker Enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- Knn
Memory intCircuit Breaker Limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- Node
Search stringCache Size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- Override
Main boolResponse Version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- Plugins
Alerting boolFilter By Backend Roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- Reindex
Remote List<string>Whitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- Remote
Store OpenSearch Opensearch User Config Opensearch Remote Store - Script
Max stringCompilations Rate - 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 OpenSearch Opensearch User Config Opensearch Search Backpressure - Search Backpressure Settings
- Search
Insights OpenTop Queries Search Opensearch User Config Opensearch Search Insights Top Queries - Search
Max intBuckets - Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example:
10000. - Segrep
Open
Search Opensearch User Config Opensearch Segrep - Segment Replication Backpressure Settings
-
Open
Search Opensearch User Config Opensearch Shard Indexing Pressure - Shard indexing back pressure settings
- Thread
Pool intAnalyze Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intAnalyze Size - 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 intForce Merge Size - 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 intGet Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intGet Size - 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 intSearch Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intSearch Size - 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 intSearch Throttled Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intSearch Throttled Size - 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 intWrite Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intWrite Size - 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 boolCreate Index Enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- Action
Destructive boolRequires Name - Require explicit index names when deleting.
- Auth
Failure OpenListeners Search Opensearch User Config Opensearch Auth Failure Listeners - Opensearch Security Plugin Settings
- Cluster
Filecache float64Remote Data Ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- Cluster
Max intShards Per Node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - Cluster
Remote OpenStore Search Opensearch User Config Opensearch Cluster Remote Store - Cluster
Routing boolAllocation Balance Prefer Primary - 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.
- Cluster
Routing intAllocation Node Concurrent Recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- Cluster
Search OpenRequest Slowlog Search Opensearch User Config Opensearch Cluster Search Request Slowlog - Disk
Watermarks OpenSearch Opensearch User Config Opensearch Disk Watermarks - Watermark settings
- Email
Sender stringName - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - Email
Sender stringPassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - Email
Sender stringUsername - Sender username for Opensearch alerts. Example:
jane@example.com. - Enable
Remote boolBacked Storage - Enable remote-backed storage.
- Enable
Searchable boolSnapshots - Enable searchable snapshots.
- Enable
Security boolAudit - Enable/Disable security audit.
- Enable
Snapshot boolApi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- Http
Max intContent Length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- Http
Max intHeader Size - The max size of allowed headers, in bytes. Example:
8192. - Http
Max intInitial Line Length - The max length of an HTTP URL, in bytes. Example:
4096. - Indices
Fielddata intCache Size - 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 intIndex Buffer Size - 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 intMax Index Buffer Size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- Indices
Memory intMin Index Buffer Size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- Indices
Queries intCache Size - 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 intBool Max Clause Count - 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 intMax Bytes Per Sec - 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 intMax Concurrent File Chunks - 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 boolEnabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- Ism
History intMax Age - The maximum age before rolling over the audit history index in hours. Example:
24. - Ism
History intMax Docs - The maximum number of documents before rolling over the audit history index.
- Ism
History intRollover Check Period - The time between rollover checks for the audit history index in hours. Example:
8. - Ism
History intRollover Retention Period - How long audit history indices are kept in days. Example:
30. - Knn
Memory boolCircuit Breaker Enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- Knn
Memory intCircuit Breaker Limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- Node
Search stringCache Size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- Override
Main boolResponse Version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- Plugins
Alerting boolFilter By Backend Roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- Reindex
Remote []stringWhitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- Remote
Store OpenSearch Opensearch User Config Opensearch Remote Store - Script
Max stringCompilations Rate - 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 OpenSearch Opensearch User Config Opensearch Search Backpressure - Search Backpressure Settings
- Search
Insights OpenTop Queries Search Opensearch User Config Opensearch Search Insights Top Queries - Search
Max intBuckets - Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example:
10000. - Segrep
Open
Search Opensearch User Config Opensearch Segrep - Segment Replication Backpressure Settings
-
Open
Search Opensearch User Config Opensearch Shard Indexing Pressure - Shard indexing back pressure settings
- Thread
Pool intAnalyze Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intAnalyze Size - 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 intForce Merge Size - 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 intGet Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intGet Size - 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 intSearch Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intSearch Size - 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 intSearch Throttled Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intSearch Throttled Size - 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 intWrite Queue Size - Size for the thread pool queue. See documentation for exact details.
- Thread
Pool intWrite Size - 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 BooleanCreate Index Enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- action
Destructive BooleanRequires Name - Require explicit index names when deleting.
- auth
Failure OpenListeners Search Opensearch User Config Opensearch Auth Failure Listeners - Opensearch Security Plugin Settings
- cluster
Filecache DoubleRemote Data Ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- cluster
Max IntegerShards Per Node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - cluster
Remote OpenStore Search Opensearch User Config Opensearch Cluster Remote Store - cluster
Routing BooleanAllocation Balance Prefer Primary - 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.
- cluster
Routing IntegerAllocation Node Concurrent Recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- cluster
Search OpenRequest Slowlog Search Opensearch User Config Opensearch Cluster Search Request Slowlog - disk
Watermarks OpenSearch Opensearch User Config Opensearch Disk Watermarks - Watermark settings
- email
Sender StringName - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - email
Sender StringPassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - email
Sender StringUsername - Sender username for Opensearch alerts. Example:
jane@example.com. - enable
Remote BooleanBacked Storage - Enable remote-backed storage.
- enable
Searchable BooleanSnapshots - Enable searchable snapshots.
- enable
Security BooleanAudit - Enable/Disable security audit.
- enable
Snapshot BooleanApi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- http
Max IntegerContent Length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- http
Max IntegerHeader Size - The max size of allowed headers, in bytes. Example:
8192. - http
Max IntegerInitial Line Length - The max length of an HTTP URL, in bytes. Example:
4096. - indices
Fielddata IntegerCache Size - 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 IntegerIndex Buffer Size - 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 IntegerMax Index Buffer Size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- indices
Memory IntegerMin Index Buffer Size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- indices
Queries IntegerCache Size - 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 IntegerBool Max Clause Count - 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 IntegerMax Bytes Per Sec - 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 IntegerMax Concurrent File Chunks - Number of file chunks sent in parallel for each recovery. Defaults to 2.
- ism
Enabled Boolean - Specifies whether ISM is enabled or not.
- ism
History BooleanEnabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- ism
History IntegerMax Age - The maximum age before rolling over the audit history index in hours. Example:
24. - ism
History IntegerMax Docs - The maximum number of documents before rolling over the audit history index.
- ism
History IntegerRollover Check Period - The time between rollover checks for the audit history index in hours. Example:
8. - ism
History IntegerRollover Retention Period - How long audit history indices are kept in days. Example:
30. - knn
Memory BooleanCircuit Breaker Enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- knn
Memory IntegerCircuit Breaker Limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- node
Search StringCache Size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- override
Main BooleanResponse Version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- plugins
Alerting BooleanFilter By Backend Roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- reindex
Remote List<String>Whitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- remote
Store OpenSearch Opensearch User Config Opensearch Remote Store - script
Max StringCompilations Rate - 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 OpenSearch Opensearch User Config Opensearch Search Backpressure - Search Backpressure Settings
- search
Insights OpenTop Queries Search Opensearch User Config Opensearch Search Insights Top Queries - search
Max IntegerBuckets - Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example:
10000. - segrep
Open
Search Opensearch User Config Opensearch Segrep - Segment Replication Backpressure Settings
-
Open
Search Opensearch User Config Opensearch Shard Indexing Pressure - Shard indexing back pressure settings
- thread
Pool IntegerAnalyze Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool IntegerAnalyze Size - 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 IntegerForce Merge Size - 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 IntegerGet Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool IntegerGet Size - 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 IntegerSearch Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool IntegerSearch Size - 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 IntegerSearch Throttled Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool IntegerSearch Throttled Size - 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 IntegerWrite Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool IntegerWrite Size - 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 booleanCreate Index Enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- action
Destructive booleanRequires Name - Require explicit index names when deleting.
- auth
Failure OpenListeners Search Opensearch User Config Opensearch Auth Failure Listeners - Opensearch Security Plugin Settings
- cluster
Filecache numberRemote Data Ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- cluster
Max numberShards Per Node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - cluster
Remote OpenStore Search Opensearch User Config Opensearch Cluster Remote Store - cluster
Routing booleanAllocation Balance Prefer Primary - 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.
- cluster
Routing numberAllocation Node Concurrent Recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- cluster
Search OpenRequest Slowlog Search Opensearch User Config Opensearch Cluster Search Request Slowlog - disk
Watermarks OpenSearch Opensearch User Config Opensearch Disk Watermarks - Watermark settings
- email
Sender stringName - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - email
Sender stringPassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - email
Sender stringUsername - Sender username for Opensearch alerts. Example:
jane@example.com. - enable
Remote booleanBacked Storage - Enable remote-backed storage.
- enable
Searchable booleanSnapshots - Enable searchable snapshots.
- enable
Security booleanAudit - Enable/Disable security audit.
- enable
Snapshot booleanApi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- http
Max numberContent Length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- http
Max numberHeader Size - The max size of allowed headers, in bytes. Example:
8192. - http
Max numberInitial Line Length - The max length of an HTTP URL, in bytes. Example:
4096. - indices
Fielddata numberCache Size - 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 numberIndex Buffer Size - 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 numberMax Index Buffer Size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- indices
Memory numberMin Index Buffer Size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- indices
Queries numberCache Size - 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 numberBool Max Clause Count - 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 numberMax Bytes Per Sec - 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 numberMax Concurrent File Chunks - Number of file chunks sent in parallel for each recovery. Defaults to 2.
- ism
Enabled boolean - Specifies whether ISM is enabled or not.
- ism
History booleanEnabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- ism
History numberMax Age - The maximum age before rolling over the audit history index in hours. Example:
24. - ism
History numberMax Docs - The maximum number of documents before rolling over the audit history index.
- ism
History numberRollover Check Period - The time between rollover checks for the audit history index in hours. Example:
8. - ism
History numberRollover Retention Period - How long audit history indices are kept in days. Example:
30. - knn
Memory booleanCircuit Breaker Enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- knn
Memory numberCircuit Breaker Limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- node
Search stringCache Size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- override
Main booleanResponse Version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- plugins
Alerting booleanFilter By Backend Roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- reindex
Remote string[]Whitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- remote
Store OpenSearch Opensearch User Config Opensearch Remote Store - script
Max stringCompilations Rate - 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 OpenSearch Opensearch User Config Opensearch Search Backpressure - Search Backpressure Settings
- search
Insights OpenTop Queries Search Opensearch User Config Opensearch Search Insights Top Queries - search
Max numberBuckets - Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example:
10000. - segrep
Open
Search Opensearch User Config Opensearch Segrep - Segment Replication Backpressure Settings
-
Open
Search Opensearch User Config Opensearch Shard Indexing Pressure - Shard indexing back pressure settings
- thread
Pool numberAnalyze Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool numberAnalyze Size - 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 numberForce Merge Size - 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 numberGet Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool numberGet Size - 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 numberSearch Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool numberSearch Size - 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 numberSearch Throttled Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool numberSearch Throttled Size - 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 numberWrite Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool numberWrite Size - 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_ boolcreate_ index_ enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- action_
destructive_ boolrequires_ name - Require explicit index names when deleting.
- auth_
failure_ Openlisteners Search Opensearch User Config Opensearch Auth Failure Listeners - Opensearch Security Plugin Settings
- cluster_
filecache_ floatremote_ data_ ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- cluster_
max_ intshards_ per_ node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - cluster_
remote_ Openstore Search Opensearch User Config Opensearch Cluster Remote Store - cluster_
routing_ boolallocation_ balance_ prefer_ primary - 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.
- cluster_
routing_ intallocation_ node_ concurrent_ recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- cluster_
search_ Openrequest_ slowlog Search Opensearch User Config Opensearch Cluster Search Request Slowlog - disk_
watermarks OpenSearch Opensearch User Config Opensearch Disk Watermarks - Watermark settings
- email_
sender_ strname - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - email_
sender_ strpassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - email_
sender_ strusername - Sender username for Opensearch alerts. Example:
jane@example.com. - enable_
remote_ boolbacked_ storage - Enable remote-backed storage.
- enable_
searchable_ boolsnapshots - Enable searchable snapshots.
- enable_
security_ boolaudit - Enable/Disable security audit.
- enable_
snapshot_ boolapi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- http_
max_ intcontent_ length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- http_
max_ intheader_ size - The max size of allowed headers, in bytes. Example:
8192. - http_
max_ intinitial_ line_ length - The max length of an HTTP URL, in bytes. Example:
4096. - indices_
fielddata_ intcache_ size - 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_ intindex_ buffer_ size - 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_ intmax_ index_ buffer_ size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- indices_
memory_ intmin_ index_ buffer_ size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- indices_
queries_ intcache_ size - 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_ intbool_ max_ clause_ count - 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_ intmax_ bytes_ per_ sec - 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_ intmax_ concurrent_ file_ chunks - 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_ boolenabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- ism_
history_ intmax_ age - The maximum age before rolling over the audit history index in hours. Example:
24. - ism_
history_ intmax_ docs - The maximum number of documents before rolling over the audit history index.
- ism_
history_ introllover_ check_ period - The time between rollover checks for the audit history index in hours. Example:
8. - ism_
history_ introllover_ retention_ period - How long audit history indices are kept in days. Example:
30. - knn_
memory_ boolcircuit_ breaker_ enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- knn_
memory_ intcircuit_ breaker_ limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- node_
search_ strcache_ size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- override_
main_ boolresponse_ version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- plugins_
alerting_ boolfilter_ by_ backend_ roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- reindex_
remote_ Sequence[str]whitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- remote_
store OpenSearch Opensearch User Config Opensearch Remote Store - script_
max_ strcompilations_ rate - 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 OpenSearch Opensearch User Config Opensearch Search Backpressure - Search Backpressure Settings
- search_
insights_ Opentop_ queries Search Opensearch User Config Opensearch Search Insights Top Queries - search_
max_ intbuckets - Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example:
10000. - segrep
Open
Search Opensearch User Config Opensearch Segrep - Segment Replication Backpressure Settings
-
Open
Search Opensearch User Config Opensearch Shard Indexing Pressure - Shard indexing back pressure settings
- thread_
pool_ intanalyze_ queue_ size - Size for the thread pool queue. See documentation for exact details.
- thread_
pool_ intanalyze_ size - 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_ intforce_ merge_ size - 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_ intget_ queue_ size - Size for the thread pool queue. See documentation for exact details.
- thread_
pool_ intget_ size - 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_ intsearch_ queue_ size - Size for the thread pool queue. See documentation for exact details.
- thread_
pool_ intsearch_ size - 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_ intsearch_ throttled_ queue_ size - Size for the thread pool queue. See documentation for exact details.
- thread_
pool_ intsearch_ throttled_ size - 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_ intwrite_ queue_ size - Size for the thread pool queue. See documentation for exact details.
- thread_
pool_ intwrite_ size - 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 BooleanCreate Index Enabled - Explicitly allow or block automatic creation of indices. Defaults to true.
- action
Destructive BooleanRequires Name - Require explicit index names when deleting.
- auth
Failure Property MapListeners - Opensearch Security Plugin Settings
- cluster
Filecache NumberRemote Data Ratio - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.
- cluster
Max NumberShards Per Node - Controls the number of shards allowed in the cluster per data node. Example:
1000. - cluster
Remote Property MapStore - cluster
Routing BooleanAllocation Balance Prefer Primary - 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.
- cluster
Routing NumberAllocation Node Concurrent Recoveries - How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.
- cluster
Search Property MapRequest Slowlog - disk
Watermarks Property Map - Watermark settings
- email
Sender StringName - Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example:
alert-sender. - email
Sender StringPassword - Sender password for Opensearch alerts to authenticate with SMTP server. Example:
very-secure-mail-password. - email
Sender StringUsername - Sender username for Opensearch alerts. Example:
jane@example.com. - enable
Remote BooleanBacked Storage - Enable remote-backed storage.
- enable
Searchable BooleanSnapshots - Enable searchable snapshots.
- enable
Security BooleanAudit - Enable/Disable security audit.
- enable
Snapshot BooleanApi - Enable/Disable snapshot API for custom repositories, this requires security management to be enabled.
- http
Max NumberContent Length - Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
- http
Max NumberHeader Size - The max size of allowed headers, in bytes. Example:
8192. - http
Max NumberInitial Line Length - The max length of an HTTP URL, in bytes. Example:
4096. - indices
Fielddata NumberCache Size - 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 NumberIndex Buffer Size - 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 NumberMax Index Buffer Size - Absolute value. Default is unbound. Doesn't work without indices.memory.indexbuffersize. Maximum amount of heap used for query cache, an absolute indices.memory.indexbuffersize maximum hard limit.
- indices
Memory NumberMin Index Buffer Size - Absolute value. Default is 48mb. Doesn't work without indices.memory.indexbuffersize. Minimum amount of heap used for query cache, an absolute indices.memory.indexbuffersize minimal hard limit.
- indices
Queries NumberCache Size - 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 NumberBool Max Clause Count - 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 NumberMax Bytes Per Sec - 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 NumberMax Concurrent File Chunks - Number of file chunks sent in parallel for each recovery. Defaults to 2.
- ism
Enabled Boolean - Specifies whether ISM is enabled or not.
- ism
History BooleanEnabled - Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
- ism
History NumberMax Age - The maximum age before rolling over the audit history index in hours. Example:
24. - ism
History NumberMax Docs - The maximum number of documents before rolling over the audit history index.
- ism
History NumberRollover Check Period - The time between rollover checks for the audit history index in hours. Example:
8. - ism
History NumberRollover Retention Period - How long audit history indices are kept in days. Example:
30. - knn
Memory BooleanCircuit Breaker Enabled - Enable or disable KNN memory circuit breaker. Defaults to true.
- knn
Memory NumberCircuit Breaker Limit - Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.
- node
Search StringCache Size - Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
- override
Main BooleanResponse Version - Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- plugins
Alerting BooleanFilter By Backend Roles - Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.
- reindex
Remote List<String>Whitelists - Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- remote
Store Property Map - script
Max StringCompilations Rate - 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 Property Map - Search Backpressure Settings
- search
Insights Property MapTop Queries - search
Max NumberBuckets - 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
- Property Map
- Shard indexing back pressure settings
- thread
Pool NumberAnalyze Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool NumberAnalyze Size - 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 NumberForce Merge Size - 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 NumberGet Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool NumberGet Size - 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 NumberSearch Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool NumberSearch Size - 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 NumberSearch Throttled Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool NumberSearch Throttled Size - 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 NumberWrite Queue Size - Size for the thread pool queue. See documentation for exact details.
- thread
Pool NumberWrite Size - 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.
OpenSearchOpensearchUserConfigOpensearchAuthFailureListeners, OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersArgs
- internal
Authentication Property MapBackend Limiting - ip
Rate Property MapLimiting - IP address rate limiting settings
OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimiting, OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersInternalAuthenticationBackendLimitingArgs
- Allowed
Tries int - The number of login attempts allowed before login is blocked. Example:
10. - Authentication
Backend string - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - Block
Expiry intSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - Max
Blocked intClients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - Max
Tracked intClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - Time
Window intSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - Type string
- Enum:
username. internalauthenticationbackend_limiting.type.
- Allowed
Tries int - The number of login attempts allowed before login is blocked. Example:
10. - Authentication
Backend string - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - Block
Expiry intSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - Max
Blocked intClients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - Max
Tracked intClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - Time
Window intSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - Type string
- Enum:
username. internalauthenticationbackend_limiting.type.
- allowed
Tries Integer - The number of login attempts allowed before login is blocked. Example:
10. - authentication
Backend String - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - block
Expiry IntegerSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked IntegerClients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - max
Tracked IntegerClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window IntegerSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type String
- Enum:
username. internalauthenticationbackend_limiting.type.
- allowed
Tries number - The number of login attempts allowed before login is blocked. Example:
10. - authentication
Backend string - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - block
Expiry numberSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked numberClients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - max
Tracked numberClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window numberSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type string
- Enum:
username. internalauthenticationbackend_limiting.type.
- allowed_
tries int - The number of login attempts allowed before login is blocked. Example:
10. - authentication_
backend str - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - block_
expiry_ intseconds - The duration of time that login remains blocked after a failed login. Example:
600. - max_
blocked_ intclients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - max_
tracked_ intclients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time_
window_ intseconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type str
- Enum:
username. internalauthenticationbackend_limiting.type.
- allowed
Tries Number - The number of login attempts allowed before login is blocked. Example:
10. - authentication
Backend String - Enum:
internal. internalauthenticationbackendlimiting.authenticationbackend. - block
Expiry NumberSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked NumberClients - internalauthenticationbackendlimiting.maxblocked_clients. Example:
100000. - max
Tracked NumberClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window NumberSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type String
- Enum:
username. internalauthenticationbackend_limiting.type.
OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimiting, OpenSearchOpensearchUserConfigOpensearchAuthFailureListenersIpRateLimitingArgs
- Allowed
Tries int - The number of login attempts allowed before login is blocked. Example:
10. - Block
Expiry intSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - Max
Blocked intClients - The maximum number of blocked IP addresses. Example:
100000. - Max
Tracked intClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - Time
Window intSeconds - The window of time in which the value for
allowed_triesis 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 intSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - Max
Blocked intClients - The maximum number of blocked IP addresses. Example:
100000. - Max
Tracked intClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - Time
Window intSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - Type string
- Enum:
ip. The type of rate limiting.
- allowed
Tries Integer - The number of login attempts allowed before login is blocked. Example:
10. - block
Expiry IntegerSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked IntegerClients - The maximum number of blocked IP addresses. Example:
100000. - max
Tracked IntegerClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window IntegerSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type String
- Enum:
ip. The type of rate limiting.
- allowed
Tries number - The number of login attempts allowed before login is blocked. Example:
10. - block
Expiry numberSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked numberClients - The maximum number of blocked IP addresses. Example:
100000. - max
Tracked numberClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window numberSeconds - The window of time in which the value for
allowed_triesis 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_ intseconds - The duration of time that login remains blocked after a failed login. Example:
600. - max_
blocked_ intclients - The maximum number of blocked IP addresses. Example:
100000. - max_
tracked_ intclients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time_
window_ intseconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type str
- Enum:
ip. The type of rate limiting.
- allowed
Tries Number - The number of login attempts allowed before login is blocked. Example:
10. - block
Expiry NumberSeconds - The duration of time that login remains blocked after a failed login. Example:
600. - max
Blocked NumberClients - The maximum number of blocked IP addresses. Example:
100000. - max
Tracked NumberClients - The maximum number of tracked IP addresses that have failed login. Example:
100000. - time
Window NumberSeconds - The window of time in which the value for
allowed_triesis enforced. Example:3600. - type String
- Enum:
ip. The type of rate limiting.
OpenSearchOpensearchUserConfigOpensearchClusterRemoteStore, OpenSearchOpensearchUserConfigOpensearchClusterRemoteStoreArgs
- State
Global stringMetadata Upload Timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- State
Metadata stringManifest Upload Timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- Translog
Buffer stringInterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - Translog
Max intReaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
- State
Global stringMetadata Upload Timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- State
Metadata stringManifest Upload Timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- Translog
Buffer stringInterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - Translog
Max intReaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
- state
Global StringMetadata Upload Timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- state
Metadata StringManifest Upload Timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- translog
Buffer StringInterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - translog
Max IntegerReaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
- state
Global stringMetadata Upload Timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- state
Metadata stringManifest Upload Timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- translog
Buffer stringInterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - translog
Max numberReaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
- state_
global_ strmetadata_ upload_ timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- state_
metadata_ strmanifest_ upload_ timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- translog_
buffer_ strinterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - translog_
max_ intreaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
- state
Global StringMetadata Upload Timeout - The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
- state
Metadata StringManifest Upload Timeout - The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
- translog
Buffer StringInterval - The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting
index.remote_store.translog.buffer_intervalis not present. Defaults to 650ms. - translog
Max NumberReaders - Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Example:
1000.
OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlog, OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogArgs
- Level string
- Enum:
debug,info,trace,warn. Log level. Default:trace. - Threshold
Open
Search Opensearch User Config Opensearch Cluster Search Request Slowlog Threshold
- Level string
- Enum:
debug,info,trace,warn. Log level. Default:trace. - Threshold
Open
Search Opensearch User Config Opensearch Cluster Search Request Slowlog Threshold
- level String
- Enum:
debug,info,trace,warn. Log level. Default:trace. - threshold
Open
Search Opensearch User Config Opensearch Cluster Search Request Slowlog Threshold
- level string
- Enum:
debug,info,trace,warn. Log level. Default:trace. - threshold
Open
Search Opensearch User Config Opensearch Cluster Search Request Slowlog Threshold
- level str
- Enum:
debug,info,trace,warn. Log level. Default:trace. - threshold
Open
Search Opensearch User Config Opensearch Cluster Search Request Slowlog Threshold
- level String
- Enum:
debug,info,trace,warn. Log level. Default:trace. - threshold Property Map
OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThreshold, OpenSearchOpensearchUserConfigOpensearchClusterSearchRequestSlowlogThresholdArgs
- 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.
OpenSearchOpensearchUserConfigOpensearchDashboards, OpenSearchOpensearchUserConfigOpensearchDashboardsArgs
- Enabled bool
- Enable or disable OpenSearch Dashboards. Default:
true. - Max
Old intSpace Size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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 boolSource Enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - Opensearch
Request intTimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
- Enabled bool
- Enable or disable OpenSearch Dashboards. Default:
true. - Max
Old intSpace Size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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 boolSource Enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - Opensearch
Request intTimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
- enabled Boolean
- Enable or disable OpenSearch Dashboards. Default:
true. - max
Old IntegerSpace Size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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 BooleanSource Enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - opensearch
Request IntegerTimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
- enabled boolean
- Enable or disable OpenSearch Dashboards. Default:
true. - max
Old numberSpace Size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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 booleanSource Enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - opensearch
Request numberTimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
- enabled bool
- Enable or disable OpenSearch Dashboards. Default:
true. - max_
old_ intspace_ size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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_ boolsource_ enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - opensearch_
request_ inttimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
- enabled Boolean
- Enable or disable OpenSearch Dashboards. Default:
true. - max
Old NumberSpace Size - Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the maxoldspace_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 BooleanSource Enabled - Enable or disable multiple data sources in OpenSearch Dashboards. Default:
true. - opensearch
Request NumberTimeout - Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. Default:
30000.
OpenSearchOpensearchUserConfigOpensearchDiskWatermarks, OpenSearchOpensearchUserConfigOpensearchDiskWatermarksArgs
- 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.
- 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.
- flood
Stage 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.
- flood
Stage 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.
- flood
Stage 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.
OpenSearchOpensearchUserConfigOpensearchRemoteStore, OpenSearchOpensearchUserConfigOpensearchRemoteStoreArgs
- Segment
Pressure doubleBytes Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- Segment
Pressure intConsecutive Failures Limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- Segment
Pressure boolEnabled - Enables remote segment backpressure. Default is
true. - Segment
Pressure doubleTime Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
- Segment
Pressure float64Bytes Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- Segment
Pressure intConsecutive Failures Limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- Segment
Pressure boolEnabled - Enables remote segment backpressure. Default is
true. - Segment
Pressure float64Time Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure DoubleBytes Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure IntegerConsecutive Failures Limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- segment
Pressure BooleanEnabled - Enables remote segment backpressure. Default is
true. - segment
Pressure DoubleTime Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure numberBytes Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure numberConsecutive Failures Limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- segment
Pressure booleanEnabled - Enables remote segment backpressure. Default is
true. - segment
Pressure numberTime Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
- segment_
pressure_ floatbytes_ lag_ variance_ factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- segment_
pressure_ intconsecutive_ failures_ limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- segment_
pressure_ boolenabled - Enables remote segment backpressure. Default is
true. - segment_
pressure_ floattime_ lag_ variance_ factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure NumberBytes Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10.
- segment
Pressure NumberConsecutive Failures Limit - The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5.
- segment
Pressure BooleanEnabled - Enables remote segment backpressure. Default is
true. - segment
Pressure NumberTime Lag Variance Factor - The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10.
OpenSearchOpensearchUserConfigOpensearchSearchBackpressure, OpenSearchOpensearchUserConfigOpensearchSearchBackpressureArgs
- Mode string
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - Node
Duress OpenSearch Opensearch User Config Opensearch Search Backpressure Node Duress - Node duress settings
- Search
Shard OpenTask Search Opensearch User Config Opensearch Search Backpressure Search Shard Task - Search shard settings
- Search
Task OpenSearch Opensearch User Config Opensearch Search Backpressure Search Task - Search task settings
- Mode string
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - Node
Duress OpenSearch Opensearch User Config Opensearch Search Backpressure Node Duress - Node duress settings
- Search
Shard OpenTask Search Opensearch User Config Opensearch Search Backpressure Search Shard Task - Search shard settings
- Search
Task OpenSearch Opensearch User Config Opensearch Search Backpressure Search Task - Search task settings
- mode String
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - node
Duress OpenSearch Opensearch User Config Opensearch Search Backpressure Node Duress - Node duress settings
- search
Shard OpenTask Search Opensearch User Config Opensearch Search Backpressure Search Shard Task - Search shard settings
- search
Task OpenSearch Opensearch User Config Opensearch Search Backpressure Search Task - Search task settings
- mode string
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - node
Duress OpenSearch Opensearch User Config Opensearch Search Backpressure Node Duress - Node duress settings
- search
Shard OpenTask Search Opensearch User Config Opensearch Search Backpressure Search Shard Task - Search shard settings
- search
Task OpenSearch Opensearch User Config Opensearch Search Backpressure Search Task - Search task settings
- mode str
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - node_
duress OpenSearch Opensearch User Config Opensearch Search Backpressure Node Duress - Node duress settings
- search_
shard_ Opentask Search Opensearch User Config Opensearch Search Backpressure Search Shard Task - Search shard settings
- search_
task OpenSearch Opensearch User Config Opensearch Search Backpressure Search Task - Search task settings
- mode String
- Enum:
disabled,enforced,monitor_only. The search backpressure mode. Valid values are monitoronly, enforced, or disabled. Default is monitoronly. - node
Duress Property Map - Node duress settings
- search
Shard Property MapTask - Search shard settings
- search
Task Property Map - Search task settings
OpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuress, OpenSearchOpensearchUserConfigOpensearchSearchBackpressureNodeDuressArgs
- Cpu
Threshold double - The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
- Heap
Threshold double - The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
- Num
Successive intBreaches - The number of successive limit breaches after which the node is considered to be under duress. Default is 3.
- Cpu
Threshold float64 - The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
- Heap
Threshold float64 - The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
- Num
Successive intBreaches - The number of successive limit breaches after which the node is considered to be under duress. Default is 3.
- cpu
Threshold Double - The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
- heap
Threshold Double - The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
- num
Successive IntegerBreaches - The number of successive limit breaches after which the node is considered to be under duress. Default is 3.
- cpu
Threshold number - The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
- heap
Threshold number - The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
- num
Successive numberBreaches - 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_ intbreaches - The number of successive limit breaches after which the node is considered to be under duress. Default is 3.
- cpu
Threshold Number - The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9.
- heap
Threshold Number - The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7.
- num
Successive NumberBreaches - The number of successive limit breaches after which the node is considered to be under duress. Default is 3.
OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTask, OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchShardTaskArgs
- Cancellation
Burst double - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
- Cancellation
Rate double - The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
- Cancellation
Ratio double - The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
- Cpu
Time intMillis Threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- Elapsed
Time intMillis Threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- Heap
Moving intAverage Window Size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- Heap
Percent doubleThreshold - 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 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.
- Total
Heap doublePercent Threshold - 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 float64 - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
- Cancellation
Rate float64 - The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
- Cancellation
Ratio float64 - The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
- Cpu
Time intMillis Threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- Elapsed
Time intMillis Threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- Heap
Moving intAverage Window Size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- Heap
Percent float64Threshold - 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 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.
- Total
Heap float64Percent Threshold - 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 Double - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
- cancellation
Rate Double - The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio Double - The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
- cpu
Time IntegerMillis Threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- elapsed
Time IntegerMillis Threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- heap
Moving IntegerAverage Window Size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- heap
Percent DoubleThreshold - 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 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.
- total
Heap DoublePercent Threshold - 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 number - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
- cancellation
Rate number - The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio number - The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
- cpu
Time numberMillis Threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- elapsed
Time numberMillis Threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- heap
Moving numberAverage Window Size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- heap
Percent numberThreshold - 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 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.
- total
Heap numberPercent Threshold - 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_ intmillis_ threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- elapsed_
time_ intmillis_ threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- heap_
moving_ intaverage_ window_ size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- heap_
percent_ floatthreshold - 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_ floatpercent_ threshold - 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 Number - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0.
- cancellation
Rate Number - The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio Number - The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1.
- cpu
Time NumberMillis Threshold - The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000.
- elapsed
Time NumberMillis Threshold - The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000.
- heap
Moving NumberAverage Window Size - The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100.
- heap
Percent NumberThreshold - 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 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.
- total
Heap NumberPercent Threshold - 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.
OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTask, OpenSearchOpensearchUserConfigOpensearchSearchBackpressureSearchTaskArgs
- Cancellation
Burst double - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
- Cancellation
Rate double - The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
- Cancellation
Ratio double - The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
- Cpu
Time intMillis Threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- Elapsed
Time intMillis Threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- Heap
Moving intAverage Window Size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- Heap
Percent doubleThreshold - 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 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.
- Total
Heap doublePercent Threshold - 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 float64 - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
- Cancellation
Rate float64 - The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
- Cancellation
Ratio float64 - The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
- Cpu
Time intMillis Threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- Elapsed
Time intMillis Threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- Heap
Moving intAverage Window Size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- Heap
Percent float64Threshold - 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 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.
- Total
Heap float64Percent Threshold - 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 Double - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
- cancellation
Rate Double - The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio Double - The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
- cpu
Time IntegerMillis Threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- elapsed
Time IntegerMillis Threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- heap
Moving IntegerAverage Window Size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- heap
Percent DoubleThreshold - 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 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.
- total
Heap DoublePercent Threshold - 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 number - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
- cancellation
Rate number - The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio number - The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
- cpu
Time numberMillis Threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- elapsed
Time numberMillis Threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- heap
Moving numberAverage Window Size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- heap
Percent numberThreshold - 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 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.
- total
Heap numberPercent Threshold - 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_ intmillis_ threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- elapsed_
time_ intmillis_ threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- heap_
moving_ intaverage_ window_ size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- heap_
percent_ floatthreshold - 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_ floatpercent_ threshold - 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 Number - The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0.
- cancellation
Rate Number - The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003.
- cancellation
Ratio Number - The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1.
- cpu
Time NumberMillis Threshold - The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000.
- elapsed
Time NumberMillis Threshold - The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000.
- heap
Moving NumberAverage Window Size - The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10.
- heap
Percent NumberThreshold - 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 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.
- total
Heap NumberPercent Threshold - 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.
OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueries, OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesArgs
- Cpu
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Cpu - Top N queries monitoring by CPU
- Latency
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Latency - Top N queries monitoring by latency
- Memory
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Memory - Top N queries monitoring by memory
- Cpu
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Cpu - Top N queries monitoring by CPU
- Latency
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Latency - Top N queries monitoring by latency
- Memory
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Memory - Top N queries monitoring by memory
- cpu
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Cpu - Top N queries monitoring by CPU
- latency
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Latency - Top N queries monitoring by latency
- memory
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Memory - Top N queries monitoring by memory
- cpu
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Cpu - Top N queries monitoring by CPU
- latency
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Latency - Top N queries monitoring by latency
- memory
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Memory - Top N queries monitoring by memory
- cpu
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Cpu - Top N queries monitoring by CPU
- latency
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Latency - Top N queries monitoring by latency
- memory
Open
Search Opensearch User Config Opensearch Search Insights Top Queries Memory - 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
OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpu, OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesCpuArgs
- Enabled bool
- Enable or disable top N query monitoring by the metric. Default:
false. - Top
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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. - top
NSize Integer - Specify the value of N for the top N queries by the metric.
- window
Size 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. - top
NSize number - Specify the value of N for the top N queries by the metric.
- window
Size 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_ intsize - 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. - top
NSize Number - Specify the value of N for the top N queries by the metric.
- window
Size String - The window size of the top N queries by the metric.
OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatency, OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesLatencyArgs
- Enabled bool
- Enable or disable top N query monitoring by the metric. Default:
false. - Top
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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. - top
NSize Integer - Specify the value of N for the top N queries by the metric.
- window
Size 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. - top
NSize number - Specify the value of N for the top N queries by the metric.
- window
Size 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_ intsize - 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. - top
NSize Number - Specify the value of N for the top N queries by the metric.
- window
Size String - The window size of the top N queries by the metric.
OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemory, OpenSearchOpensearchUserConfigOpensearchSearchInsightsTopQueriesMemoryArgs
- Enabled bool
- Enable or disable top N query monitoring by the metric. Default:
false. - Top
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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
NSize int - Specify the value of N for the top N queries by the metric.
- Window
Size 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. - top
NSize Integer - Specify the value of N for the top N queries by the metric.
- window
Size 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. - top
NSize number - Specify the value of N for the top N queries by the metric.
- window
Size 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_ intsize - 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. - top
NSize Number - Specify the value of N for the top N queries by the metric.
- window
Size String - The window size of the top N queries by the metric.
OpenSearchOpensearchUserConfigOpensearchSegrep, OpenSearchOpensearchUserConfigOpensearchSegrepArgs
- Pressure
Checkpoint intLimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.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 doubleStale Limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - Pressure
Time stringLimit - 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 intLimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.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 float64Stale Limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - Pressure
Time stringLimit - 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 IntegerLimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default:4. - pressure
Enabled Boolean - Enables the segment replication backpressure mechanism. Default is false. Default:
false. - pressure
Replica DoubleStale Limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - pressure
Time StringLimit - 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 numberLimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default:4. - pressure
Enabled boolean - Enables the segment replication backpressure mechanism. Default is false. Default:
false. - pressure
Replica numberStale Limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - pressure
Time stringLimit - 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_ intlimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.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_ floatstale_ limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - pressure_
time_ strlimit - 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 NumberLimit - The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once
segrep.pressure.checkpoint.limitis breached along withsegrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Default:4. - pressure
Enabled Boolean - Enables the segment replication backpressure mechanism. Default is false. Default:
false. - pressure
Replica NumberStale Limit - The maximum number of stale replica shards that can exist in a replication group. Once
segrep.pressure.replica.stale.limitis breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Default:0.5. - pressure
Time StringLimit - 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.
OpenSearchOpensearchUserConfigOpensearchShardIndexingPressure, OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureArgs
- 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 OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Operating Factor - Operating factor
- Primary
Parameter OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Primary Parameter - 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 OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Operating Factor - Operating factor
- Primary
Parameter OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Primary Parameter - 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.
- operating
Factor OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Operating Factor - Operating factor
- primary
Parameter OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Primary Parameter - 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.
- operating
Factor OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Operating Factor - Operating factor
- primary
Parameter OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Primary Parameter - 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 OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Operating Factor - Operating factor
- primary_
parameter OpenSearch Opensearch User Config Opensearch Shard Indexing Pressure Primary Parameter - 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.
- operating
Factor Property Map - Operating factor
- primary
Parameter Property Map - Primary parameter
OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactor, OpenSearchOpensearchUserConfigOpensearchShardIndexingPressureOperatingFactorArgs
- 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.
OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameter, OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterArgs
OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNode, OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterNodeArgs
- Soft
Limit 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.
- Soft
Limit 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.
- soft
Limit 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.
- soft
Limit 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.
- soft
Limit 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.
OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShard, OpenSearchOpensearchUserConfigOpensearchShardIndexingPressurePrimaryParameterShardArgs
- Min
Limit 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.
- Min
Limit 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.
- min
Limit 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.
- min
Limit 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.
- min
Limit 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.
OpenSearchOpensearchUserConfigPrivateAccess, OpenSearchOpensearchUserConfigPrivateAccessArgs
- 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 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.
- opensearch
Dashboards 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.
- opensearch
Dashboards 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.
- opensearch
Dashboards 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.
OpenSearchOpensearchUserConfigPrivatelinkAccess, OpenSearchOpensearchUserConfigPrivatelinkAccessArgs
- Opensearch bool
- Enable opensearch.
- Opensearch
Dashboards bool - Enable opensearch_dashboards.
- Prometheus bool
- Enable prometheus.
- Opensearch bool
- Enable opensearch.
- Opensearch
Dashboards bool - Enable opensearch_dashboards.
- Prometheus bool
- Enable prometheus.
- opensearch Boolean
- Enable opensearch.
- opensearch
Dashboards Boolean - Enable opensearch_dashboards.
- prometheus Boolean
- Enable prometheus.
- opensearch boolean
- Enable opensearch.
- opensearch
Dashboards 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.
- opensearch
Dashboards Boolean - Enable opensearch_dashboards.
- prometheus Boolean
- Enable prometheus.
OpenSearchOpensearchUserConfigPublicAccess, OpenSearchOpensearchUserConfigPublicAccessArgs
- 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 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.
- opensearch
Dashboards 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.
- opensearch
Dashboards 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.
- opensearch
Dashboards 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.
OpenSearchOpensearchUserConfigS3Migration, OpenSearchOpensearchUserConfigS3MigrationArgs
- Access
Key string - AWS Access key.
- Base
Path 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.
- Secret
Key string - AWS secret key.
- Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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.
- 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 boolState - If true, restore the cluster state. Defaults to false.
- Server
Side boolEncryption - When set to true files are encrypted on server side.
- Access
Key string - AWS Access key.
- Base
Path 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.
- Secret
Key string - AWS secret key.
- Snapshot
Name string - The snapshot name to restore from.
- Chunk
Size 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.
- 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 boolState - If true, restore the cluster state. Defaults to false.
- Server
Side boolEncryption - When set to true files are encrypted on server side.
- access
Key String - AWS Access key.
- base
Path 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.
- secret
Key String - AWS secret key.
- snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases Boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly Boolean
- Whether the repository is read-only. Default:
true. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
- server
Side BooleanEncryption - When set to true files are encrypted on server side.
- access
Key string - AWS Access key.
- base
Path 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.
- secret
Key string - AWS secret key.
- snapshot
Name string - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly boolean
- Whether the repository is read-only. Default:
true. - restore
Global booleanState - If true, restore the cluster state. Defaults to false.
- server
Side booleanEncryption - 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_ boolstate - If true, restore the cluster state. Defaults to false.
- server_
side_ boolencryption - When set to true files are encrypted on server side.
- access
Key String - AWS Access key.
- base
Path 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.
- secret
Key String - AWS secret key.
- snapshot
Name String - The snapshot name to restore from.
- chunk
Size 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.
- include
Aliases Boolean - Whether to restore aliases alongside their associated indexes. Default is true.
- readonly Boolean
- Whether the repository is read-only. Default:
true. - restore
Global BooleanState - If true, restore the cluster state. Defaults to false.
- server
Side BooleanEncryption - When set to true files are encrypted on server side.
OpenSearchOpensearchUserConfigSaml, OpenSearchOpensearchUserConfigSamlArgs
- 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 stringId - 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 stringUrl - 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 stringId - 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 stringContent - 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 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. - Subject
Key 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 stringId - 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 stringUrl - 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 stringId - 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 stringContent - 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 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. - Subject
Key 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. - idp
Entity StringId - 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 StringUrl - 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 StringId - 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 StringContent - 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 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. - subject
Key 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. - idp
Entity stringId - 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 stringUrl - 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 stringId - 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 stringContent - 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 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. - subject
Key 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_ strid - 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_ strurl - 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_ strid - 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_ strcontent - 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. - idp
Entity StringId - 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 StringUrl - 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 StringId - 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 StringContent - 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 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. - subject
Key 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.
OpenSearchServiceIntegration, OpenSearchServiceIntegrationArgs
- Integration
Type string - Type of the service integration
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration
- source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration
- source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration
- source
Service StringName - Name of the source service
OpenSearchTag, OpenSearchTagArgs
OpenSearchTechEmail, OpenSearchTechEmailArgs
- 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
Import
$ pulumi import aiven:index/openSearch:OpenSearch example_opensearch PROJECT/SERVICE_NAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aivenTerraform Provider.
