1. Packages
  2. Aiven Provider
  3. API Docs
  4. getOpensearchSecurityPluginConfig
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.getOpensearchSecurityPluginConfig

aiven logo
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Gets information about OpenSearch Security configuration for an Aiven for OpenSearch® service.

    Example Usage

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

const os_sec_config = aiven.getOpensearchSecurityPluginConfig({
    project: exampleProject.project,
    serviceName: exampleOpensearch.serviceName,
});

    import pulumi
import pulumi_aiven as aiven

os_sec_config = aiven.get_opensearch_security_plugin_config(project=example_project["project"],
    service_name=example_opensearch["serviceName"])

    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.LookupOpensearchSecurityPluginConfig(ctx, &aiven.LookupOpensearchSecurityPluginConfigArgs{
			Project:     exampleProject.Project,
			ServiceName: exampleOpensearch.ServiceName,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var os_sec_config = Aiven.GetOpensearchSecurityPluginConfig.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleOpensearch.ServiceName,
    });

});

    package generated_program;

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

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

    public static void stack(Context ctx) {
        final var os-sec-config = AivenFunctions.getOpensearchSecurityPluginConfig(GetOpensearchSecurityPluginConfigArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleOpensearch.serviceName())
            .build());

    }
}

    variables:
  os-sec-config:
    fn::invoke:
      function: aiven:getOpensearchSecurityPluginConfig
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleOpensearch.serviceName}

    Using getOpensearchSecurityPluginConfig

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

    function getOpensearchSecurityPluginConfig(args: GetOpensearchSecurityPluginConfigArgs, opts?: InvokeOptions): Promise<GetOpensearchSecurityPluginConfigResult>
function getOpensearchSecurityPluginConfigOutput(args: GetOpensearchSecurityPluginConfigOutputArgs, opts?: InvokeOptions): Output<GetOpensearchSecurityPluginConfigResult>
    def get_opensearch_security_plugin_config(project: Optional[str] = None,
                                          service_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetOpensearchSecurityPluginConfigResult
def get_opensearch_security_plugin_config_output(project: Optional[pulumi.Input[str]] = None,
                                          service_name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchSecurityPluginConfigResult]
    func LookupOpensearchSecurityPluginConfig(ctx *Context, args *LookupOpensearchSecurityPluginConfigArgs, opts ...InvokeOption) (*LookupOpensearchSecurityPluginConfigResult, error)
func LookupOpensearchSecurityPluginConfigOutput(ctx *Context, args *LookupOpensearchSecurityPluginConfigOutputArgs, opts ...InvokeOption) LookupOpensearchSecurityPluginConfigResultOutput

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

    public static class GetOpensearchSecurityPluginConfig 
{
    public static Task<GetOpensearchSecurityPluginConfigResult> InvokeAsync(GetOpensearchSecurityPluginConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchSecurityPluginConfigResult> Invoke(GetOpensearchSecurityPluginConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOpensearchSecurityPluginConfigResult> getOpensearchSecurityPluginConfig(GetOpensearchSecurityPluginConfigArgs args, InvokeOptions options)
public static Output<GetOpensearchSecurityPluginConfigResult> getOpensearchSecurityPluginConfig(GetOpensearchSecurityPluginConfigArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    getOpensearchSecurityPluginConfig Result

    The following output properties are available:

    AdminEnabled bool
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    AdminPassword string
    The password for the os-sec-admin user.
    Available bool
    Whether the security plugin is available. This is always true for recently created services.
    Enabled bool
    Whether the security plugin is enabled. This is always true for recently created services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    AdminEnabled bool
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    AdminPassword string
    The password for the os-sec-admin user.
    Available bool
    Whether the security plugin is available. This is always true for recently created services.
    Enabled bool
    Whether the security plugin is enabled. This is always true for recently created services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    adminEnabled Boolean
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    adminPassword String
    The password for the os-sec-admin user.
    available Boolean
    Whether the security plugin is available. This is always true for recently created services.
    enabled Boolean
    Whether the security plugin is enabled. This is always true for recently created services.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    adminEnabled boolean
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    adminPassword string
    The password for the os-sec-admin user.
    available boolean
    Whether the security plugin is available. This is always true for recently created services.
    enabled boolean
    Whether the security plugin is enabled. This is always true for recently created services.
    id string
    The provider-assigned unique ID for this managed resource.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    admin_enabled bool
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    admin_password str
    The password for the os-sec-admin user.
    available bool
    Whether the security plugin is available. This is always true for recently created services.
    enabled bool
    Whether the security plugin is enabled. This is always true for recently created services.
    id str
    The provider-assigned unique ID for this managed resource.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    adminEnabled Boolean
    Whether the os-sec-admin user is enabled. This indicates whether OpenSearch Security management is enabled. This is always true when the os-sec-admin password was set at least once.
    adminPassword String
    The password for the os-sec-admin user.
    available Boolean
    Whether the security plugin is available. This is always true for recently created services.
    enabled Boolean
    Whether the security plugin is enabled. This is always true for recently created services.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.51.0
    published on Tuesday, Mar 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.