1. Packages
  2. Aiven
  3. API Docs
  4. OpenSearch
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.OpenSearch

Explore with Pulumi AI

aiven logo
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    CloudName 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, do google, 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.

    DiskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    MaintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    MaintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    OpensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    ProjectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    ServiceIntegrations List<OpenSearchServiceIntegration>

    Service integrations to specify when creating a service. Not applied after initial service creation

    StaticIps List<string>

    Use static public IP addresses.

    Tags List<OpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    TerminationProtection bool

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Plan string

    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    CloudName 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, do google, 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.

    DiskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    MaintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    MaintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    OpensearchUserConfig OpenSearchOpensearchUserConfigArgs

    Opensearch user configurable settings

    ProjectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    ServiceIntegrations []OpenSearchServiceIntegrationArgs

    Service integrations to specify when creating a service. Not applied after initial service creation

    StaticIps []string

    Use static public IP addresses.

    Tags []OpenSearchTagArgs

    Tags are key-value pairs that allow you to categorize services.

    TerminationProtection bool

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    plan String

    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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.

    diskSpace String

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow String

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime String

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    projectVpcId String

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceIntegrations List<OpenSearchServiceIntegration>

    Service integrations to specify when creating a service. Not applied after initial service creation

    staticIps List<String>

    Use static public IP addresses.

    tags List<OpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection Boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    plan string

    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    serviceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    additionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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.

    diskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    projectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceIntegrations OpenSearchServiceIntegration[]

    Service integrations to specify when creating a service. Not applied after initial service creation

    staticIps string[]

    Use static public IP addresses.

    tags OpenSearchTag[]

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    plan str

    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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_space str

    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, do google, 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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenance_window_dow str

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenance_window_time str

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearch_user_config OpenSearchOpensearchUserConfigArgs

    Opensearch user configurable settings

    project_vpc_id str

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    service_integrations Sequence[OpenSearchServiceIntegrationArgs]

    Service integrations to specify when creating a service. Not applied after initial service creation

    static_ips Sequence[str]

    Use static public IP addresses.

    tags Sequence[OpenSearchTagArgs]

    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 true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    plan String

    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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.

    diskSpace String

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow String

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime String

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig Property Map

    Opensearch user configurable settings

    projectVpcId String

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceIntegrations List<Property Map>

    Service integrations to specify when creating a service. Not applied after initial service creation

    staticIps List<String>

    Use static public IP addresses.

    tags List<Property Map>

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection Boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OpenSearch resource produces the following output properties:

    Components List<OpenSearchComponent>

    Service component information objects

    DiskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    DiskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    DiskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    DiskSpaceUsed string

    Disk space that service is currently using

    Id string

    The provider-assigned unique ID for this managed resource.

    Opensearches List<OpenSearchOpensearch>

    OpenSearch settings.

    ServiceHost string

    The hostname of the service.

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    Components []OpenSearchComponent

    Service component information objects

    DiskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    DiskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    DiskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    DiskSpaceUsed string

    Disk space that service is currently using

    Id string

    The provider-assigned unique ID for this managed resource.

    Opensearches []OpenSearchOpensearch

    OpenSearch settings.

    ServiceHost string

    The hostname of the service.

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    components List<OpenSearchComponent>

    Service component information objects

    diskSpaceCap String

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault String

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep String

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed String

    Disk space that service is currently using

    id String

    The provider-assigned unique ID for this managed resource.

    opensearches List<OpenSearchOpensearch>

    OpenSearch settings.

    serviceHost String

    The hostname of the service.

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Integer

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    components OpenSearchComponent[]

    Service component information objects

    diskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed string

    Disk space that service is currently using

    id string

    The provider-assigned unique ID for this managed resource.

    opensearches OpenSearchOpensearch[]

    OpenSearch settings.

    serviceHost string

    The hostname of the service.

    servicePassword string

    Password used for connecting to the service, if applicable

    servicePort number

    The port of the service

    serviceType string

    Aiven internal service type code

    serviceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername string

    Username used for connecting to the service, if applicable

    state string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    components Sequence[OpenSearchComponent]

    Service component information objects

    disk_space_cap str

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    disk_space_default str

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    disk_space_step str

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    disk_space_used str

    Disk space that service is currently using

    id str

    The provider-assigned unique ID for this managed resource.

    opensearches Sequence[OpenSearchOpensearch]

    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, REBUILDING or RUNNING

    components List<Property Map>

    Service component information objects

    diskSpaceCap String

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault String

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep String

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed String

    Disk space that service is currently using

    id String

    The provider-assigned unique ID for this managed resource.

    opensearches List<Property Map>

    OpenSearch settings.

    serviceHost String

    The hostname of the service.

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Number

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    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) -> OpenSearch
    func 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.
    The following state arguments are supported:
    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    CloudName 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, do google, 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<OpenSearchComponent>

    Service component information objects

    DiskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    DiskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    DiskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    DiskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    DiskSpaceUsed string

    Disk space that service is currently using

    MaintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    MaintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    OpensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    Opensearches List<OpenSearchOpensearch>

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    ProjectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations List<OpenSearchServiceIntegration>

    Service integrations to specify when creating a service. Not applied after initial service creation

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    StaticIps List<string>

    Use static public IP addresses.

    Tags List<OpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    TerminationProtection bool

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    CloudName 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, do google, 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 []OpenSearchComponentArgs

    Service component information objects

    DiskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    DiskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    DiskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    DiskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    DiskSpaceUsed string

    Disk space that service is currently using

    MaintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    MaintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    OpensearchUserConfig OpenSearchOpensearchUserConfigArgs

    Opensearch user configurable settings

    Opensearches []OpenSearchOpensearchArgs

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    ProjectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations []OpenSearchServiceIntegrationArgs

    Service integrations to specify when creating a service. Not applied after initial service creation

    ServiceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    StaticIps []string

    Use static public IP addresses.

    Tags []OpenSearchTagArgs

    Tags are key-value pairs that allow you to categorize services.

    TerminationProtection bool

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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<OpenSearchComponent>

    Service component information objects

    diskSpace String

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    diskSpaceCap String

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault String

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep String

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed String

    Disk space that service is currently using

    maintenanceWindowDow String

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime String

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    opensearches List<OpenSearchOpensearch>

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    projectVpcId String

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceHost String

    The hostname of the service.

    serviceIntegrations List<OpenSearchServiceIntegration>

    Service integrations to specify when creating a service. Not applied after initial service creation

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Integer

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    staticIps List<String>

    Use static public IP addresses.

    tags List<OpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection Boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    additionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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 OpenSearchComponent[]

    Service component information objects

    diskSpace string

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    diskSpaceCap string

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault string

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep string

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed string

    Disk space that service is currently using

    maintenanceWindowDow string

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime string

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig OpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    opensearches OpenSearchOpensearch[]

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    projectVpcId string

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceHost string

    The hostname of the service.

    serviceIntegrations OpenSearchServiceIntegration[]

    Service integrations to specify when creating a service. Not applied after initial service creation

    serviceName string

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    servicePassword string

    Password used for connecting to the service, if applicable

    servicePort number

    The port of the service

    serviceType string

    Aiven internal service type code

    serviceUri string

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername string

    Username used for connecting to the service, if applicable

    state string

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    staticIps string[]

    Use static public IP addresses.

    tags OpenSearchTag[]

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    additional_disk_space str

    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, do google, 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[OpenSearchComponentArgs]

    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.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    disk_space_cap str

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    disk_space_default str

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    disk_space_step str

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    disk_space_used str

    Disk space that service is currently using

    maintenance_window_dow str

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenance_window_time str

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearch_user_config OpenSearchOpensearchUserConfigArgs

    Opensearch user configurable settings

    opensearches Sequence[OpenSearchOpensearchArgs]

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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_id str

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    service_host str

    The hostname of the service.

    service_integrations Sequence[OpenSearchServiceIntegrationArgs]

    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, REBUILDING or RUNNING

    static_ips Sequence[str]

    Use static public IP addresses.

    tags Sequence[OpenSearchTagArgs]

    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 true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    cloudName 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, do google, 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

    diskSpace String

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    Deprecated:

    This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    diskSpaceCap String

    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

    diskSpaceDefault String

    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

    diskSpaceStep String

    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

    diskSpaceUsed String

    Disk space that service is currently using

    maintenanceWindowDow String

    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

    maintenanceWindowTime String

    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

    opensearchUserConfig Property Map

    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-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be 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.

    projectVpcId String

    Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

    serviceHost String

    The hostname of the service.

    serviceIntegrations List<Property Map>

    Service integrations to specify when creating a service. Not applied after initial service creation

    serviceName String

    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Number

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

    staticIps List<String>

    Use static public IP addresses.

    tags List<Property Map>

    Tags are key-value pairs that allow you to categorize services.

    terminationProtection Boolean

    Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

    Supporting Types

    OpenSearchComponent, OpenSearchComponentArgs

    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Integer
    route String
    ssl Boolean
    usage String
    component string
    host string
    kafkaAuthenticationMethod string
    port number
    route string
    ssl boolean
    usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Number
    route String
    ssl Boolean
    usage String

    OpenSearchOpensearch, OpenSearchOpensearchArgs

    OpenSearchOpensearchUserConfig, OpenSearchOpensearchUserConfigArgs

    AdditionalBackupRegions string

    Additional Cloud Regions for Backup Replication.

    CustomDomain string

    Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

    DisableReplicationFactorAdjustment bool

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    IndexPatterns List<OpenSearchOpensearchUserConfigIndexPattern>

    Index patterns.

    IndexTemplate OpenSearchOpensearchUserConfigIndexTemplate

    Template settings for all new indexes.

    IpFilterObjects List<OpenSearchOpensearchUserConfigIpFilterObject>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    IpFilterStrings List<string>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    IpFilters List<string>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    KeepIndexRefreshInterval bool

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    MaxIndexCount int

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    Openid OpenSearchOpensearchUserConfigOpenid

    OpenSearch OpenID Connect Configuration.

    Opensearch OpenSearchOpensearchUserConfigOpensearch

    OpenSearch settings.

    OpensearchDashboards OpenSearchOpensearchUserConfigOpensearchDashboards

    OpenSearch Dashboards settings.

    OpensearchVersion string

    OpenSearch major version.

    PrivateAccess OpenSearchOpensearchUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    PrivatelinkAccess OpenSearchOpensearchUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    ProjectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    PublicAccess OpenSearchOpensearchUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    RecoveryBasebackupName string

    Name of the basebackup to restore in forked service.

    Saml OpenSearchOpensearchUserConfigSaml

    OpenSearch SAML configuration.

    ServiceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

    StaticIps bool

    Use static public IP addresses.

    AdditionalBackupRegions string

    Additional Cloud Regions for Backup Replication.

    CustomDomain string

    Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

    DisableReplicationFactorAdjustment bool

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    IndexPatterns []OpenSearchOpensearchUserConfigIndexPattern

    Index patterns.

    IndexTemplate OpenSearchOpensearchUserConfigIndexTemplate

    Template settings for all new indexes.

    IpFilterObjects []OpenSearchOpensearchUserConfigIpFilterObject

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    IpFilterStrings []string

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    IpFilters []string

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    KeepIndexRefreshInterval bool

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    MaxIndexCount int

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    Openid OpenSearchOpensearchUserConfigOpenid

    OpenSearch OpenID Connect Configuration.

    Opensearch OpenSearchOpensearchUserConfigOpensearch

    OpenSearch settings.

    OpensearchDashboards OpenSearchOpensearchUserConfigOpensearchDashboards

    OpenSearch Dashboards settings.

    OpensearchVersion string

    OpenSearch major version.

    PrivateAccess OpenSearchOpensearchUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    PrivatelinkAccess OpenSearchOpensearchUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    ProjectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    PublicAccess OpenSearchOpensearchUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    RecoveryBasebackupName string

    Name of the basebackup to restore in forked service.

    Saml OpenSearchOpensearchUserConfigSaml

    OpenSearch SAML configuration.

    ServiceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

    StaticIps bool

    Use static public IP addresses.

    additionalBackupRegions String

    Additional Cloud Regions for Backup Replication.

    customDomain String

    Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

    disableReplicationFactorAdjustment Boolean

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    indexPatterns List<OpenSearchOpensearchUserConfigIndexPattern>

    Index patterns.

    indexTemplate OpenSearchOpensearchUserConfigIndexTemplate

    Template settings for all new indexes.

    ipFilterObjects List<OpenSearchOpensearchUserConfigIpFilterObject>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilterStrings List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilters List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keepIndexRefreshInterval Boolean

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    maxIndexCount Integer

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    openid OpenSearchOpensearchUserConfigOpenid

    OpenSearch OpenID Connect Configuration.

    opensearch OpenSearchOpensearchUserConfigOpensearch

    OpenSearch settings.

    opensearchDashboards OpenSearchOpensearchUserConfigOpensearchDashboards

    OpenSearch Dashboards settings.

    opensearchVersion String

    OpenSearch major version.

    privateAccess OpenSearchOpensearchUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelinkAccess OpenSearchOpensearchUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    projectToForkFrom String

    Name of another project to fork a service from. This has effect only when a new service is being created.

    publicAccess OpenSearchOpensearchUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recoveryBasebackupName String

    Name of the basebackup to restore in forked service.

    saml OpenSearchOpensearchUserConfigSaml

    OpenSearch SAML configuration.

    serviceToForkFrom String

    Name of another service to fork from. This has effect only when a new service is being created.

    staticIps Boolean

    Use static public IP addresses.

    additionalBackupRegions string

    Additional Cloud Regions for Backup Replication.

    customDomain string

    Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

    disableReplicationFactorAdjustment boolean

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    indexPatterns OpenSearchOpensearchUserConfigIndexPattern[]

    Index patterns.

    indexTemplate OpenSearchOpensearchUserConfigIndexTemplate

    Template settings for all new indexes.

    ipFilterObjects OpenSearchOpensearchUserConfigIpFilterObject[]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilterStrings string[]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilters string[]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keepIndexRefreshInterval boolean

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    maxIndexCount number

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    openid OpenSearchOpensearchUserConfigOpenid

    OpenSearch OpenID Connect Configuration.

    opensearch OpenSearchOpensearchUserConfigOpensearch

    OpenSearch settings.

    opensearchDashboards OpenSearchOpensearchUserConfigOpensearchDashboards

    OpenSearch Dashboards settings.

    opensearchVersion string

    OpenSearch major version.

    privateAccess OpenSearchOpensearchUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelinkAccess OpenSearchOpensearchUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    projectToForkFrom string

    Name of another project to fork a service from. This has effect only when a new service is being created.

    publicAccess OpenSearchOpensearchUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recoveryBasebackupName string

    Name of the basebackup to restore in forked service.

    saml OpenSearchOpensearchUserConfigSaml

    OpenSearch SAML configuration.

    serviceToForkFrom string

    Name of another service to fork from. This has effect only when a new service is being created.

    staticIps boolean

    Use static public IP addresses.

    additional_backup_regions str

    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_factor_adjustment bool

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    index_patterns Sequence[OpenSearchOpensearchUserConfigIndexPattern]

    Index patterns.

    index_template OpenSearchOpensearchUserConfigIndexTemplate

    Template settings for all new indexes.

    ip_filter_objects Sequence[OpenSearchOpensearchUserConfigIpFilterObject]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ip_filter_strings Sequence[str]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ip_filters Sequence[str]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keep_index_refresh_interval bool

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    max_index_count int

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    openid OpenSearchOpensearchUserConfigOpenid

    OpenSearch OpenID Connect Configuration.

    opensearch OpenSearchOpensearchUserConfigOpensearch

    OpenSearch settings.

    opensearch_dashboards OpenSearchOpensearchUserConfigOpensearchDashboards

    OpenSearch Dashboards settings.

    opensearch_version str

    OpenSearch major version.

    private_access OpenSearchOpensearchUserConfigPrivateAccess

    Allow access to selected service ports from private networks.

    privatelink_access OpenSearchOpensearchUserConfigPrivatelinkAccess

    Allow access to selected service components through Privatelink.

    project_to_fork_from str

    Name of another project to fork a service from. This has effect only when a new service is being created.

    public_access OpenSearchOpensearchUserConfigPublicAccess

    Allow access to selected service ports from the public Internet.

    recovery_basebackup_name str

    Name of the basebackup to restore in forked service.

    saml OpenSearchOpensearchUserConfigSaml

    OpenSearch SAML configuration.

    service_to_fork_from str

    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.

    additionalBackupRegions String

    Additional Cloud Regions for Backup Replication.

    customDomain String

    Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

    disableReplicationFactorAdjustment Boolean

    Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.

    Deprecated:

    Usage of this field is discouraged.

    indexPatterns List<Property Map>

    Index patterns.

    indexTemplate Property Map

    Template settings for all new indexes.

    ipFilterObjects List<Property Map>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilterStrings List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    ipFilters List<String>

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keepIndexRefreshInterval Boolean

    Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

    maxIndexCount Number

    Use index_patterns instead. The default value is 0.

    Deprecated:

    Usage of this field is discouraged.

    openid Property Map

    OpenSearch OpenID Connect Configuration.

    opensearch Property Map

    OpenSearch settings.

    opensearchDashboards Property Map

    OpenSearch Dashboards settings.

    opensearchVersion String

    OpenSearch major version.

    privateAccess Property Map

    Allow access to selected service ports from private networks.

    privatelinkAccess Property Map

    Allow access to selected service components through Privatelink.

    projectToForkFrom String

    Name of another project to fork a service from. This has effect only when a new service is being created.

    publicAccess Property Map

    Allow access to selected service ports from the public Internet.

    recoveryBasebackupName String

    Name of the basebackup to restore in forked service.

    saml Property Map

    OpenSearch SAML configuration.

    serviceToForkFrom String

    Name of another service to fork from. This has effect only when a new service is being created.

    staticIps Boolean

    Use static public IP addresses.

    OpenSearchOpensearchUserConfigIndexPattern, OpenSearchOpensearchUserConfigIndexPatternArgs

    MaxIndexCount int

    Maximum number of indexes to keep.

    Pattern string

    fnmatch pattern.

    SortingAlgorithm string

    Deletion sorting algorithm. The default value is creation_date.

    MaxIndexCount int

    Maximum number of indexes to keep.

    Pattern string

    fnmatch pattern.

    SortingAlgorithm string

    Deletion sorting algorithm. The default value is creation_date.

    maxIndexCount Integer

    Maximum number of indexes to keep.

    pattern String

    fnmatch pattern.

    sortingAlgorithm String

    Deletion sorting algorithm. The default value is creation_date.

    maxIndexCount number

    Maximum number of indexes to keep.

    pattern string

    fnmatch pattern.

    sortingAlgorithm string

    Deletion sorting algorithm. The default value is creation_date.

    max_index_count int

    Maximum number of indexes to keep.

    pattern str

    fnmatch pattern.

    sorting_algorithm str

    Deletion sorting algorithm. The default value is creation_date.

    maxIndexCount Number

    Maximum number of indexes to keep.

    pattern String

    fnmatch pattern.

    sortingAlgorithm String

    Deletion sorting algorithm. The default value is creation_date.

    OpenSearchOpensearchUserConfigIndexTemplate, OpenSearchOpensearchUserConfigIndexTemplateArgs

    MappingNestedObjectsLimit int

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    NumberOfReplicas int

    The number of replicas each primary shard has.

    NumberOfShards int

    The number of primary shards that an index should have.

    MappingNestedObjectsLimit int

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    NumberOfReplicas int

    The number of replicas each primary shard has.

    NumberOfShards int

    The number of primary shards that an index should have.

    mappingNestedObjectsLimit Integer

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    numberOfReplicas Integer

    The number of replicas each primary shard has.

    numberOfShards Integer

    The number of primary shards that an index should have.

    mappingNestedObjectsLimit number

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    numberOfReplicas number

    The number of replicas each primary shard has.

    numberOfShards number

    The number of primary shards that an index should have.

    mapping_nested_objects_limit int

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    number_of_replicas int

    The number of replicas each primary shard has.

    number_of_shards int

    The number of primary shards that an index should have.

    mappingNestedObjectsLimit Number

    The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

    numberOfReplicas Number

    The number of replicas each primary shard has.

    numberOfShards Number

    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

    ClientId string

    The ID of the OpenID Connect client configured in your IdP. Required.

    ClientSecret string

    The client secret of the OpenID Connect client configured in your IdP. Required.

    ConnectUrl string

    The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.

    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.

    JwtHeader string

    The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.

    JwtUrlParameter string

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    RefreshRateLimitCount int

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    RefreshRateLimitTimeWindowMs int

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is 10000.

    RolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    Scope string

    The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

    SubjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    ClientId string

    The ID of the OpenID Connect client configured in your IdP. Required.

    ClientSecret string

    The client secret of the OpenID Connect client configured in your IdP. Required.

    ConnectUrl string

    The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.

    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.

    JwtHeader string

    The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.

    JwtUrlParameter string

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    RefreshRateLimitCount int

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    RefreshRateLimitTimeWindowMs int

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is 10000.

    RolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    Scope string

    The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

    SubjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    clientId String

    The ID of the OpenID Connect client configured in your IdP. Required.

    clientSecret String

    The client secret of the OpenID Connect client configured in your IdP. Required.

    connectUrl String

    The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.

    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.

    jwtHeader String

    The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.

    jwtUrlParameter String

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    refreshRateLimitCount Integer

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    refreshRateLimitTimeWindowMs Integer

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is 10000.

    rolesKey String

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    scope String

    The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

    subjectKey String

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    clientId string

    The ID of the OpenID Connect client configured in your IdP. Required.

    clientSecret string

    The client secret of the OpenID Connect client configured in your IdP. Required.

    connectUrl string

    The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.

    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.

    jwtHeader string

    The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.

    jwtUrlParameter string

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    refreshRateLimitCount number

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    refreshRateLimitTimeWindowMs number

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is 10000.

    rolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    scope string

    The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

    subjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    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_parameter str

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    refresh_rate_limit_count int

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    refresh_rate_limit_time_window_ms int

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). 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.

    clientId String

    The ID of the OpenID Connect client configured in your IdP. Required.

    clientSecret String

    The client secret of the OpenID Connect client configured in your IdP. Required.

    connectUrl String

    The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.

    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.

    jwtHeader String

    The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.

    jwtUrlParameter String

    If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.

    refreshRateLimitCount Number

    The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is 10.

    refreshRateLimitTimeWindowMs Number

    The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is 10000.

    rolesKey String

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    scope String

    The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

    subjectKey String

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    OpenSearchOpensearchUserConfigOpensearch, OpenSearchOpensearchUserConfigOpensearchArgs

    ActionAutoCreateIndexEnabled bool

    Explicitly allow or block automatic creation of indices. Defaults to true.

    ActionDestructiveRequiresName bool

    Require explicit index names when deleting.

    ClusterMaxShardsPerNode int

    Controls the number of shards allowed in the cluster per data node.

    ClusterRoutingAllocationNodeConcurrentRecoveries int

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    EmailSenderName string

    This should be identical to the Sender name defined in Opensearch dashboards.

    EmailSenderPassword string

    Sender password for Opensearch alerts to authenticate with SMTP server.

    EmailSenderUsername string

    Sender username for Opensearch alerts.

    HttpMaxContentLength int

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    HttpMaxHeaderSize int

    The max size of allowed headers, in bytes.

    HttpMaxInitialLineLength int

    The max length of an HTTP URL, in bytes.

    IndicesFielddataCacheSize int

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    IndicesMemoryIndexBufferSize int

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    IndicesQueriesCacheSize int

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    IndicesQueryBoolMaxClauseCount int

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    IndicesRecoveryMaxBytesPerSec int

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    IndicesRecoveryMaxConcurrentFileChunks int

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    OverrideMainResponseVersion bool

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    ReindexRemoteWhitelists List<string>

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    ScriptMaxCompilationsRate string

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    SearchMaxBuckets int

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    ThreadPoolAnalyzeQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolAnalyzeSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolForceMergeSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolGetQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolGetSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolSearchQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolSearchSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolSearchThrottledQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolSearchThrottledSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolWriteQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolWriteSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ActionAutoCreateIndexEnabled bool

    Explicitly allow or block automatic creation of indices. Defaults to true.

    ActionDestructiveRequiresName bool

    Require explicit index names when deleting.

    ClusterMaxShardsPerNode int

    Controls the number of shards allowed in the cluster per data node.

    ClusterRoutingAllocationNodeConcurrentRecoveries int

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    EmailSenderName string

    This should be identical to the Sender name defined in Opensearch dashboards.

    EmailSenderPassword string

    Sender password for Opensearch alerts to authenticate with SMTP server.

    EmailSenderUsername string

    Sender username for Opensearch alerts.

    HttpMaxContentLength int

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    HttpMaxHeaderSize int

    The max size of allowed headers, in bytes.

    HttpMaxInitialLineLength int

    The max length of an HTTP URL, in bytes.

    IndicesFielddataCacheSize int

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    IndicesMemoryIndexBufferSize int

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    IndicesQueriesCacheSize int

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    IndicesQueryBoolMaxClauseCount int

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    IndicesRecoveryMaxBytesPerSec int

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    IndicesRecoveryMaxConcurrentFileChunks int

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    OverrideMainResponseVersion bool

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    ReindexRemoteWhitelists []string

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    ScriptMaxCompilationsRate string

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    SearchMaxBuckets int

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    ThreadPoolAnalyzeQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolAnalyzeSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolForceMergeSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolGetQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolGetSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolSearchQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolSearchSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolSearchThrottledQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolSearchThrottledSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    ThreadPoolWriteQueueSize int

    Size for the thread pool queue. See documentation for exact details.

    ThreadPoolWriteSize int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    actionAutoCreateIndexEnabled Boolean

    Explicitly allow or block automatic creation of indices. Defaults to true.

    actionDestructiveRequiresName Boolean

    Require explicit index names when deleting.

    clusterMaxShardsPerNode Integer

    Controls the number of shards allowed in the cluster per data node.

    clusterRoutingAllocationNodeConcurrentRecoveries Integer

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    emailSenderName String

    This should be identical to the Sender name defined in Opensearch dashboards.

    emailSenderPassword String

    Sender password for Opensearch alerts to authenticate with SMTP server.

    emailSenderUsername String

    Sender username for Opensearch alerts.

    httpMaxContentLength Integer

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    httpMaxHeaderSize Integer

    The max size of allowed headers, in bytes.

    httpMaxInitialLineLength Integer

    The max length of an HTTP URL, in bytes.

    indicesFielddataCacheSize Integer

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    indicesMemoryIndexBufferSize Integer

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    indicesQueriesCacheSize Integer

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    indicesQueryBoolMaxClauseCount Integer

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    indicesRecoveryMaxBytesPerSec Integer

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    indicesRecoveryMaxConcurrentFileChunks Integer

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    overrideMainResponseVersion Boolean

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    reindexRemoteWhitelists List<String>

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    scriptMaxCompilationsRate String

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    searchMaxBuckets Integer

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    threadPoolAnalyzeQueueSize Integer

    Size for the thread pool queue. See documentation for exact details.

    threadPoolAnalyzeSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolForceMergeSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolGetQueueSize Integer

    Size for the thread pool queue. See documentation for exact details.

    threadPoolGetSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchQueueSize Integer

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchThrottledQueueSize Integer

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchThrottledSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolWriteQueueSize Integer

    Size for the thread pool queue. See documentation for exact details.

    threadPoolWriteSize Integer

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    actionAutoCreateIndexEnabled boolean

    Explicitly allow or block automatic creation of indices. Defaults to true.

    actionDestructiveRequiresName boolean

    Require explicit index names when deleting.

    clusterMaxShardsPerNode number

    Controls the number of shards allowed in the cluster per data node.

    clusterRoutingAllocationNodeConcurrentRecoveries number

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    emailSenderName string

    This should be identical to the Sender name defined in Opensearch dashboards.

    emailSenderPassword string

    Sender password for Opensearch alerts to authenticate with SMTP server.

    emailSenderUsername string

    Sender username for Opensearch alerts.

    httpMaxContentLength number

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    httpMaxHeaderSize number

    The max size of allowed headers, in bytes.

    httpMaxInitialLineLength number

    The max length of an HTTP URL, in bytes.

    indicesFielddataCacheSize number

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    indicesMemoryIndexBufferSize number

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    indicesQueriesCacheSize number

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    indicesQueryBoolMaxClauseCount number

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    indicesRecoveryMaxBytesPerSec number

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    indicesRecoveryMaxConcurrentFileChunks number

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    overrideMainResponseVersion boolean

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    reindexRemoteWhitelists string[]

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    scriptMaxCompilationsRate string

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    searchMaxBuckets number

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    threadPoolAnalyzeQueueSize number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolAnalyzeSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolForceMergeSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolGetQueueSize number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolGetSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchQueueSize number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchThrottledQueueSize number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchThrottledSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolWriteQueueSize number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolWriteSize number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    action_auto_create_index_enabled bool

    Explicitly allow or block automatic creation of indices. Defaults to true.

    action_destructive_requires_name bool

    Require explicit index names when deleting.

    cluster_max_shards_per_node int

    Controls the number of shards allowed in the cluster per data node.

    cluster_routing_allocation_node_concurrent_recoveries int

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    email_sender_name str

    This should be identical to the Sender name defined in Opensearch dashboards.

    email_sender_password str

    Sender password for Opensearch alerts to authenticate with SMTP server.

    email_sender_username str

    Sender username for Opensearch alerts.

    http_max_content_length int

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    http_max_header_size int

    The max size of allowed headers, in bytes.

    http_max_initial_line_length int

    The max length of an HTTP URL, in bytes.

    indices_fielddata_cache_size int

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    indices_memory_index_buffer_size int

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    indices_queries_cache_size int

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    indices_query_bool_max_clause_count int

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    indices_recovery_max_bytes_per_sec int

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    indices_recovery_max_concurrent_file_chunks int

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    override_main_response_version bool

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    reindex_remote_whitelists Sequence[str]

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    script_max_compilations_rate str

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    search_max_buckets int

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    thread_pool_analyze_queue_size int

    Size for the thread pool queue. See documentation for exact details.

    thread_pool_analyze_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    thread_pool_force_merge_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    thread_pool_get_queue_size int

    Size for the thread pool queue. See documentation for exact details.

    thread_pool_get_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    thread_pool_search_queue_size int

    Size for the thread pool queue. See documentation for exact details.

    thread_pool_search_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    thread_pool_search_throttled_queue_size int

    Size for the thread pool queue. See documentation for exact details.

    thread_pool_search_throttled_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    thread_pool_write_queue_size int

    Size for the thread pool queue. See documentation for exact details.

    thread_pool_write_size int

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    actionAutoCreateIndexEnabled Boolean

    Explicitly allow or block automatic creation of indices. Defaults to true.

    actionDestructiveRequiresName Boolean

    Require explicit index names when deleting.

    clusterMaxShardsPerNode Number

    Controls the number of shards allowed in the cluster per data node.

    clusterRoutingAllocationNodeConcurrentRecoveries Number

    How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.

    emailSenderName String

    This should be identical to the Sender name defined in Opensearch dashboards.

    emailSenderPassword String

    Sender password for Opensearch alerts to authenticate with SMTP server.

    emailSenderUsername String

    Sender username for Opensearch alerts.

    httpMaxContentLength Number

    Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

    httpMaxHeaderSize Number

    The max size of allowed headers, in bytes.

    httpMaxInitialLineLength Number

    The max length of an HTTP URL, in bytes.

    indicesFielddataCacheSize Number

    Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

    indicesMemoryIndexBufferSize Number

    Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

    indicesQueriesCacheSize Number

    Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

    indicesQueryBoolMaxClauseCount Number

    Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

    indicesRecoveryMaxBytesPerSec Number

    Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

    indicesRecoveryMaxConcurrentFileChunks Number

    Number of file chunks sent in parallel for each recovery. Defaults to 2.

    overrideMainResponseVersion Boolean

    Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

    reindexRemoteWhitelists List<String>

    Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

    scriptMaxCompilationsRate String

    Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.

    searchMaxBuckets Number

    Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

    threadPoolAnalyzeQueueSize Number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolAnalyzeSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolForceMergeSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolGetQueueSize Number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolGetSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchQueueSize Number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolSearchThrottledQueueSize Number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolSearchThrottledSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    threadPoolWriteQueueSize Number

    Size for the thread pool queue. See documentation for exact details.

    threadPoolWriteSize Number

    Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

    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.

    MaxOldSpaceSize int

    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.

    OpensearchRequestTimeout int

    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.

    MaxOldSpaceSize int

    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.

    OpensearchRequestTimeout int

    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.

    maxOldSpaceSize Integer

    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.

    opensearchRequestTimeout Integer

    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.

    maxOldSpaceSize number

    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.

    opensearchRequestTimeout number

    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_space_size int

    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_timeout int

    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.

    maxOldSpaceSize Number

    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.

    opensearchRequestTimeout Number

    Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is 30000.

    OpenSearchOpensearchUserConfigPrivateAccess, OpenSearchOpensearchUserConfigPrivateAccessArgs

    Opensearch bool

    OpenSearch settings.

    OpensearchDashboards 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.

    OpensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    OpensearchDashboards 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.

    OpensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    OpensearchDashboards 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.

    OpensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    opensearchDashboards 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.

    IdpEntityId string

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    IdpMetadataUrl string

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    SpEntityId string

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    IdpPemtrustedcasContent string

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    RolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    SubjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    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.

    IdpEntityId string

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    IdpMetadataUrl string

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    SpEntityId string

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    IdpPemtrustedcasContent string

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    RolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    SubjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    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.

    idpEntityId String

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    idpMetadataUrl String

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    spEntityId String

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    idpPemtrustedcasContent String

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    rolesKey String

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    subjectKey String

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    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.

    idpEntityId string

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    idpMetadataUrl string

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    spEntityId string

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    idpPemtrustedcasContent string

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    rolesKey string

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    subjectKey string

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    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_id str

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    idp_metadata_url str

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    sp_entity_id str

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    idp_pemtrustedcas_content str

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    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.

    idpEntityId String

    The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.

    idpMetadataUrl String

    The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.

    spEntityId String

    The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.

    idpPemtrustedcasContent String

    This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.

    rolesKey String

    The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.

    subjectKey String

    The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.

    OpenSearchServiceIntegration, OpenSearchServiceIntegrationArgs

    IntegrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    SourceServiceName string

    Name of the source service

    IntegrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    SourceServiceName string

    Name of the source service

    integrationType String

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName String

    Name of the source service

    integrationType string

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName string

    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_name str

    Name of the source service

    integrationType String

    Type of the service integration. The only supported value at the moment is read_replica

    sourceServiceName String

    Name of the source service

    OpenSearchTag, OpenSearchTagArgs

    Key string

    Service tag key

    Value string

    Service tag value

    Key string

    Service tag key

    Value string

    Service tag value

    key String

    Service tag key

    value String

    Service tag value

    key string

    Service tag key

    value string

    Service tag value

    key str

    Service tag key

    value str

    Service tag value

    key String

    Service tag key

    value String

    Service tag value

    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 aiven Terraform Provider.

    aiven logo
    Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi