Docs
Packagesaiven.OpenSearch
Explore with Pulumi AI
The OpenSearch resource allows the creation and management of Aiven OpenSearch services.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var os1 = new Aiven.OpenSearch("os1", new()
{
Project = data.Aiven_project.Pr1.Project,
CloudName = "google-europe-west1",
Plan = "startup-4",
ServiceName = "my-os1",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
OpensearchUserConfig = new Aiven.Inputs.OpenSearchOpensearchUserConfigArgs
{
OpensearchVersion = "1",
OpensearchDashboards = new Aiven.Inputs.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs
{
Enabled = true,
OpensearchRequestTimeout = 30000,
},
PublicAccess = new Aiven.Inputs.OpenSearchOpensearchUserConfigPublicAccessArgs
{
Opensearch = true,
OpensearchDashboards = 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, "os1", &aiven.OpenSearchArgs{
Project: pulumi.Any(data.Aiven_project.Pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("startup-4"),
ServiceName: pulumi.String("my-os1"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
OpensearchUserConfig: &aiven.OpenSearchOpensearchUserConfigArgs{
OpensearchVersion: pulumi.String("1"),
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
})
}
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 os1 = new OpenSearch("os1", OpenSearchArgs.builder()
.project(data.aiven_project().pr1().project())
.cloudName("google-europe-west1")
.plan("startup-4")
.serviceName("my-os1")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.opensearchUserConfig(OpenSearchOpensearchUserConfigArgs.builder()
.opensearchVersion(1)
.opensearchDashboards(OpenSearchOpensearchUserConfigOpensearchDashboardsArgs.builder()
.enabled(true)
.opensearchRequestTimeout(30000)
.build())
.publicAccess(OpenSearchOpensearchUserConfigPublicAccessArgs.builder()
.opensearch(true)
.opensearchDashboards(true)
.build())
.build())
.build());
}
}
import pulumi
import pulumi_aiven as aiven
os1 = aiven.OpenSearch("os1",
project=data["aiven_project"]["pr1"]["project"],
cloud_name="google-europe-west1",
plan="startup-4",
service_name="my-os1",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
opensearch_user_config=aiven.OpenSearchOpensearchUserConfigArgs(
opensearch_version="1",
opensearch_dashboards=aiven.OpenSearchOpensearchUserConfigOpensearchDashboardsArgs(
enabled=True,
opensearch_request_timeout=30000,
),
public_access=aiven.OpenSearchOpensearchUserConfigPublicAccessArgs(
opensearch=True,
opensearch_dashboards=True,
),
))
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const os1 = new aiven.OpenSearch("os1", {
project: data.aiven_project.pr1.project,
cloudName: "google-europe-west1",
plan: "startup-4",
serviceName: "my-os1",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
opensearchUserConfig: {
opensearchVersion: "1",
opensearchDashboards: {
enabled: true,
opensearchRequestTimeout: 30000,
},
publicAccess: {
opensearch: true,
opensearchDashboards: true,
},
},
});
resources:
os1:
type: aiven:OpenSearch
properties:
project: ${data.aiven_project.pr1.project}
cloudName: google-europe-west1
plan: startup-4
serviceName: my-os1
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
opensearchUserConfig:
opensearchVersion: 1
opensearchDashboards:
enabled: true
opensearchRequestTimeout: 30000
publicAccess:
opensearch: true
opensearchDashboards: true
Create OpenSearch Resource
new OpenSearch(name: string, args: OpenSearchArgs, opts?: CustomResourceOptions);@overload
def OpenSearch(resource_name: str,
opts: Optional[ResourceOptions] = None,
additional_disk_space: Optional[str] = None,
cloud_name: Optional[str] = None,
disk_space: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
opensearch_user_config: Optional[OpenSearchOpensearchUserConfigArgs] = None,
plan: Optional[str] = None,
project: Optional[str] = None,
project_vpc_id: Optional[str] = None,
service_integrations: Optional[Sequence[OpenSearchServiceIntegrationArgs]] = None,
service_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[OpenSearchTagArgs]] = None,
termination_protection: Optional[bool] = None)
@overload
def OpenSearch(resource_name: str,
args: OpenSearchArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
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 seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations List<OpenSearch Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips List<string> Use static public IP addresses.
-
List<Open
Search Tag> Tags are key-value pairs that allow you to categorize services.
- 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 seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations []OpenSearch Service Integration Args Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []string Use static public IP addresses.
-
[]Open
Search Tag Args Tags are key-value pairs that allow you to categorize services.
- 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 seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations List<OpenSearch Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> Use static public IP addresses.
-
List<Open
Search Tag> Tags are key-value pairs that allow you to categorize services.
- 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 seem from the Aiven pricing page.- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations OpenSearch Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips string[] Use static public IP addresses.
-
Open
Search Tag[] Tags are key-value pairs that allow you to categorize services.
- 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 seem from the Aiven pricing page.- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- project_
vpc_ strid Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
integrations Sequence[OpenSearch Service Integration Args] Service integrations to specify when creating a service. Not applied after initial service creation
- static_
ips Sequence[str] Use static public IP addresses.
-
Sequence[Open
Search Tag Args] Tags are key-value pairs that allow you to categorize services.
- 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 seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations List<Property Map> Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> Use static public IP addresses.
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- 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 Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Opensearches
List<Open
Search Opensearch> OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- 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 Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Opensearches
[]Open
Search Opensearch OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- 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 Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- opensearches
List<Open
Search Opensearch> OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- 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 Disk space that service is currently using
- id string
The provider-assigned unique ID for this managed resource.
- opensearches
Open
Search Opensearch[] OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- 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 Disk space that service is currently using
- id str
The provider-assigned unique ID for this managed resource.
- opensearches
Sequence[Open
Search Opensearch] OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- 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 Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- opensearches List<Property Map>
OpenSearch settings.
- 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
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_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,
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)Resource lookup is not supported in YAML- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- Opensearches
List<Open
Search Opensearch> OpenSearch settings.
- 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 seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- Static
Ips List<string> Use static public IP addresses.
-
List<Open
Search Tag> Tags are key-value pairs that allow you to categorize services.
- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- Opensearches
[]Open
Search Opensearch Args OpenSearch settings.
- 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 seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- Static
Ips []string Use static public IP addresses.
-
[]Open
Search Tag Args Tags are key-value pairs that allow you to categorize services.
- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- opensearches
List<Open
Search Opensearch> OpenSearch settings.
- 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 seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- static
Ips List<String> Use static public IP addresses.
-
List<Open
Search Tag> Tags are key-value pairs that allow you to categorize services.
- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- opensearches
Open
Search Opensearch[] OpenSearch settings.
- 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 seem from the Aiven pricing page.- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- static
Ips string[] Use static public IP addresses.
-
Open
Search Tag[] Tags are key-value pairs that allow you to categorize services.
- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- opensearches
Sequence[Open
Search Opensearch Args] OpenSearch settings.
- 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 seem from the Aiven pricing page.- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project_
vpc_ strid Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
host str The hostname of the service.
- service_
integrations Sequence[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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- static_
ips Sequence[str] Use static public IP addresses.
-
Sequence[Open
Search Tag Args] Tags are key-value pairs that allow you to categorize services.
- 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 Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- 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.
This will be removed in v5.0.0. Please use
additional_disk_spaceto specify the space to be added to the defaultdisk_spacedefined 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 Disk space that service is currently using
- 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
- opensearches List<Property Map>
OpenSearch settings.
- 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 seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host 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
Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING- static
Ips List<String> Use static public IP addresses.
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- 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
OpenSearchOpensearch, OpenSearchOpensearchArgs
- Opensearch
Dashboards stringUri
- Opensearch
Dashboards stringUri
- opensearch
Dashboards StringUri
- opensearch
Dashboards stringUri
- opensearch
Dashboards StringUri
OpenSearchOpensearchUserConfig, OpenSearchOpensearchUserConfigArgs
- Additional
Backup stringRegions Additional Cloud Regions for Backup Replication.
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- Index
Patterns List<OpenSearch Opensearch User Config Index Pattern> Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- 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 OpenSearch major 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.
- 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.
- Saml
Open
Search Opensearch User Config Saml OpenSearch SAML configuration.
- Service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- Static
Ips bool Use static public IP addresses.
- Additional
Backup stringRegions Additional Cloud Regions for Backup Replication.
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- Index
Patterns []OpenSearch Opensearch User Config Index Pattern Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- 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 OpenSearch major 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.
- 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.
- Saml
Open
Search Opensearch User Config Saml OpenSearch SAML configuration.
- Service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- Static
Ips bool Use static public IP addresses.
- additional
Backup StringRegions Additional Cloud Regions for Backup Replication.
- custom
Domain String Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- index
Patterns List<OpenSearch Opensearch User Config Index Pattern> Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- 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 OpenSearch major 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.
- 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.
- saml
Open
Search Opensearch User Config Saml OpenSearch SAML configuration.
- service
To StringFork From Name of another service to fork from. This has effect only when a new service is being created.
- static
Ips Boolean Use static public IP addresses.
- additional
Backup stringRegions Additional Cloud Regions for Backup Replication.
- custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- index
Patterns OpenSearch Opensearch User Config Index Pattern[] Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- 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 OpenSearch major 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.
- 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.
- saml
Open
Search Opensearch User Config Saml OpenSearch SAML configuration.
- service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- static
Ips boolean Use static public IP addresses.
- additional_
backup_ strregions Additional Cloud Regions for Backup Replication.
- custom_
domain str Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- index_
patterns Sequence[OpenSearch Opensearch User Config Index Pattern] Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- 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 OpenSearch major 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.
- 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.
- saml
Open
Search Opensearch User Config Saml OpenSearch SAML configuration.
- service_
to_ strfork_ from Name of another service to fork from. This has effect only when a new service is being created.
- static_
ips bool Use static public IP addresses.
- additional
Backup StringRegions Additional Cloud Regions for Backup Replication.
- custom
Domain String Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- 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 no longer be activated.
Usage of this field is discouraged.
- index
Patterns List<Property Map> Index patterns.
- 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'.
This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- 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. The default value is
0.Usage of this field is discouraged.
- openid Property Map
OpenSearch OpenID Connect Configuration.
- opensearch Property Map
OpenSearch settings.
- opensearch
Dashboards Property Map OpenSearch Dashboards settings.
- opensearch
Version String OpenSearch major 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.
- 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.
- saml Property Map
OpenSearch SAML configuration.
- service
To StringFork From Name of another service to fork from. This has effect only when a new service is being created.
- static
Ips Boolean Use static public IP addresses.
OpenSearchOpensearchUserConfigIndexPattern, OpenSearchOpensearchUserConfigIndexPatternArgs
- Max
Index intCount Maximum number of indexes to keep.
- Pattern string
fnmatch pattern.
- Sorting
Algorithm string Deletion sorting algorithm. The default value is
creation_date.
- Max
Index intCount Maximum number of indexes to keep.
- Pattern string
fnmatch pattern.
- Sorting
Algorithm string Deletion sorting algorithm. The default value is
creation_date.
- max
Index IntegerCount Maximum number of indexes to keep.
- pattern String
fnmatch pattern.
- sorting
Algorithm String Deletion sorting algorithm. The default value is
creation_date.
- max
Index numberCount Maximum number of indexes to keep.
- pattern string
fnmatch pattern.
- sorting
Algorithm string Deletion sorting algorithm. The default value is
creation_date.
- max_
index_ intcount Maximum number of indexes to keep.
- pattern str
fnmatch pattern.
- sorting_
algorithm str Deletion sorting algorithm. The default value is
creation_date.
- max
Index NumberCount Maximum number of indexes to keep.
- pattern String
fnmatch pattern.
- sorting
Algorithm String Deletion sorting algorithm. The default value is
creation_date.
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.
- Number
Of intReplicas The number of replicas each primary shard has.
- Number
Of intShards The number of primary shards that an index should have.
- 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.
- Number
Of intReplicas The number of replicas each primary shard has.
- Number
Of intShards The number of primary shards that an index should have.
- 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.
- number
Of IntegerReplicas The number of replicas each primary shard has.
- number
Of IntegerShards The number of primary shards that an index should have.
- 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.
- number
Of numberReplicas The number of replicas each primary shard has.
- number
Of numberShards The number of primary shards that an index should have.
- 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.
- number_
of_ intreplicas The number of replicas each primary shard has.
- number_
of_ intshards The number of primary shards that an index should have.
- 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.
- number
Of NumberReplicas The number of replicas each primary shard has.
- number
Of NumberShards The number of primary shards that an index should have.
OpenSearchOpensearchUserConfigIpFilterObject, OpenSearchOpensearchUserConfigIpFilterObjectArgs
- Network string
CIDR address block.
- Description string
Description for IP filter list entry.
- Network string
CIDR address block.
- Description string
Description for IP filter list entry.
- network String
CIDR address block.
- description String
Description for IP filter list entry.
- network string
CIDR address block.
- description string
Description for IP filter list entry.
- network str
CIDR address block.
- description str
Description for IP filter list entry.
- network String
CIDR address block.
- description String
Description for IP filter list entry.
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.
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- Header string
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- Refresh
Rate intLimit Count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
- 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.
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- Header string
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- Refresh
Rate intLimit Count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
- 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.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- header String
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- refresh
Rate IntegerLimit Count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
- 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.
- enabled boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- header string
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- refresh
Rate numberLimit Count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
- 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.
- enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- header str
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- refresh_
rate_ intlimit_ count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
- 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.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
true.- header String
HTTP header name of the JWT token. Optional. Default is Authorization. The default value is
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.
- 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.
- refresh
Rate NumberLimit Count The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is
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). The default value is
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.
- 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.
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.
- Cluster
Max intShards Per Node Controls the number of shards allowed in the cluster per data node.
- Cluster
Routing intAllocation Node Concurrent Recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- Email
Sender stringName This should be identical to the Sender name defined in Opensearch dashboards.
- Email
Sender stringPassword Sender password for Opensearch alerts to authenticate with SMTP server.
- Email
Sender stringUsername Sender username for Opensearch alerts.
- 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.
- Http
Max intInitial Line Length The max length of an HTTP URL, in bytes.
- 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
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.
- Override
Main boolResponse Version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- Reindex
Remote List<string>Whitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- Script
Max stringCompilations Rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- Search
Max intBuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
- Cluster
Max intShards Per Node Controls the number of shards allowed in the cluster per data node.
- Cluster
Routing intAllocation Node Concurrent Recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- Email
Sender stringName This should be identical to the Sender name defined in Opensearch dashboards.
- Email
Sender stringPassword Sender password for Opensearch alerts to authenticate with SMTP server.
- Email
Sender stringUsername Sender username for Opensearch alerts.
- 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.
- Http
Max intInitial Line Length The max length of an HTTP URL, in bytes.
- 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
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.
- Override
Main boolResponse Version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- Reindex
Remote []stringWhitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- Script
Max stringCompilations Rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- Search
Max intBuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
- cluster
Max IntegerShards Per Node Controls the number of shards allowed in the cluster per data node.
- cluster
Routing IntegerAllocation Node Concurrent Recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- email
Sender StringName This should be identical to the Sender name defined in Opensearch dashboards.
- email
Sender StringPassword Sender password for Opensearch alerts to authenticate with SMTP server.
- email
Sender StringUsername Sender username for Opensearch alerts.
- 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.
- http
Max IntegerInitial Line Length The max length of an HTTP URL, in bytes.
- 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
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.
- override
Main BooleanResponse Version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- reindex
Remote List<String>Whitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script
Max StringCompilations Rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- search
Max IntegerBuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
- cluster
Max numberShards Per Node Controls the number of shards allowed in the cluster per data node.
- cluster
Routing numberAllocation Node Concurrent Recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- email
Sender stringName This should be identical to the Sender name defined in Opensearch dashboards.
- email
Sender stringPassword Sender password for Opensearch alerts to authenticate with SMTP server.
- email
Sender stringUsername Sender username for Opensearch alerts.
- 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.
- http
Max numberInitial Line Length The max length of an HTTP URL, in bytes.
- 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
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.
- override
Main booleanResponse Version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- reindex
Remote string[]Whitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script
Max stringCompilations Rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- search
Max numberBuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
- cluster_
max_ intshards_ per_ node Controls the number of shards allowed in the cluster per data node.
- cluster_
routing_ intallocation_ node_ concurrent_ recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- email_
sender_ strname This should be identical to the Sender name defined in Opensearch dashboards.
- email_
sender_ strpassword Sender password for Opensearch alerts to authenticate with SMTP server.
- email_
sender_ strusername Sender username for Opensearch alerts.
- 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.
- http_
max_ intinitial_ line_ length The max length of an HTTP URL, in bytes.
- 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_
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.
- override_
main_ boolresponse_ version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- reindex_
remote_ Sequence[str]whitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script_
max_ strcompilations_ rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- search_
max_ intbuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
- cluster
Max NumberShards Per Node Controls the number of shards allowed in the cluster per data node.
- cluster
Routing NumberAllocation Node Concurrent Recoveries How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
- email
Sender StringName This should be identical to the Sender name defined in Opensearch dashboards.
- email
Sender StringPassword Sender password for Opensearch alerts to authenticate with SMTP server.
- email
Sender StringUsername Sender username for Opensearch alerts.
- 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.
- http
Max NumberInitial Line Length The max length of an HTTP URL, in bytes.
- 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
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.
- override
Main BooleanResponse Version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
- reindex
Remote List<String>Whitelists Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script
Max StringCompilations Rate Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
- search
Max NumberBuckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
- 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.
OpenSearchOpensearchUserConfigOpensearchDashboards, OpenSearchOpensearchUserConfigOpensearchDashboardsArgs
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- Opensearch
Request intTimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- Opensearch
Request intTimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- opensearch
Request IntegerTimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
- enabled boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- opensearch
Request numberTimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
- enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- opensearch_
request_ inttimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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. The default value is
128.- opensearch
Request NumberTimeout Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is
30000.
OpenSearchOpensearchUserConfigPrivateAccess, OpenSearchOpensearchUserConfigPrivateAccessArgs
- Opensearch bool
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch_
dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch_
dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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.
OpenSearchOpensearchUserConfigPublicAccess, OpenSearchOpensearchUserConfigPublicAccessArgs
- Opensearch bool
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- Opensearch
Dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards boolean OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch_
dashboards bool OpenSearch Dashboards settings.
- 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
OpenSearch settings.
- opensearch
Dashboards Boolean OpenSearch Dashboards settings.
- 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.
OpenSearchOpensearchUserConfigSaml, OpenSearchOpensearchUserConfigSamlArgs
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- Enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- enabled boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- enabled bool
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- enabled Boolean
Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is
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.
- 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.
- 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.
- 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.
- 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.
- 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.
OpenSearchServiceIntegration, OpenSearchServiceIntegrationArgs
- Integration
Type string Type of the service integration. The only supported value at the moment is
read_replica- Source
Service stringName Name of the source service
- Integration
Type string Type of the service integration. The only supported value at the moment is
read_replica- Source
Service stringName Name of the source service
- integration
Type String Type of the service integration. The only supported value at the moment is
read_replica- source
Service StringName Name of the source service
- integration
Type string Type of the service integration. The only supported value at the moment is
read_replica- source
Service stringName Name of the source service
- integration_
type str Type of the service integration. The only supported value at the moment is
read_replica- source_
service_ strname Name of the source service
- integration
Type String Type of the service integration. The only supported value at the moment is
read_replica- source
Service StringName Name of the source service
OpenSearchTag, OpenSearchTagArgs
Import
$ pulumi import aiven:index/openSearch:OpenSearch os1 project/service_name
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aivenTerraform Provider.