1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. OpensearchSecurityPluginConfig
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.OpensearchSecurityPluginConfig

aiven logo
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Enables and manages OpenSearch Security for an Aiven for OpenSearch® service. After enabling OpenSearch Security management, you can no longer use Aiven Terraform Provider to manage access controls for that service. To manage user authentication and access control with OpenSearch Security management enabled, use the OpenSearch Security Dashboard or OpenSearch Security API. Once enabled, OpenSearch Security management cannot be disabled. To disable it, contact Aiven support. If this resource is missing (for example, after a service power off), it’s removed from the state and a new create plan is generated.

    Example Usage

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

const main = new aiven.OpensearchSecurityPluginConfig("main", {
    project: exampleProject.project,
    serviceName: exampleOpensearch.serviceName,
    adminPassword: opensearchSecurityAdminPassword,
});

    import pulumi
import pulumi_aiven as aiven

main = aiven.OpensearchSecurityPluginConfig("main",
    project=example_project["project"],
    service_name=example_opensearch["serviceName"],
    admin_password=opensearch_security_admin_password)

    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.NewOpensearchSecurityPluginConfig(ctx, "main", &aiven.OpensearchSecurityPluginConfigArgs{
			Project:       pulumi.Any(exampleProject.Project),
			ServiceName:   pulumi.Any(exampleOpensearch.ServiceName),
			AdminPassword: pulumi.Any(opensearchSecurityAdminPassword),
		})
		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 main = new Aiven.Index.OpensearchSecurityPluginConfig("main", new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleOpensearch.ServiceName,
        AdminPassword = opensearchSecurityAdminPassword,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.OpensearchSecurityPluginConfig;
import com.pulumi.aiven.OpensearchSecurityPluginConfigArgs;
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 main = new OpensearchSecurityPluginConfig("main", OpensearchSecurityPluginConfigArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleOpensearch.serviceName())
            .adminPassword(opensearchSecurityAdminPassword)
            .build());

    }
}

    resources:
  main:
    type: aiven:OpensearchSecurityPluginConfig
    properties:
      project: ${exampleProject.project}
      serviceName: ${exampleOpensearch.serviceName}
      adminPassword: ${opensearchSecurityAdminPassword}

    Create OpensearchSecurityPluginConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OpensearchSecurityPluginConfig(name: string, args: OpensearchSecurityPluginConfigArgs, opts?: CustomResourceOptions);
    @overload
def OpensearchSecurityPluginConfig(resource_name: str,
                                   args: OpensearchSecurityPluginConfigArgs,
                                   opts: Optional[ResourceOptions] = None)

@overload
def OpensearchSecurityPluginConfig(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   admin_password: Optional[str] = None,
                                   project: Optional[str] = None,
                                   service_name: Optional[str] = None,
                                   timeouts: Optional[OpensearchSecurityPluginConfigTimeoutsArgs] = None)
    func NewOpensearchSecurityPluginConfig(ctx *Context, name string, args OpensearchSecurityPluginConfigArgs, opts ...ResourceOption) (*OpensearchSecurityPluginConfig, error)
    public OpensearchSecurityPluginConfig(string name, OpensearchSecurityPluginConfigArgs args, CustomResourceOptions? opts = null)
    public OpensearchSecurityPluginConfig(String name, OpensearchSecurityPluginConfigArgs args)
public OpensearchSecurityPluginConfig(String name, OpensearchSecurityPluginConfigArgs args, CustomResourceOptions options)

    type: aiven:OpensearchSecurityPluginConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OpensearchSecurityPluginConfigArgs
    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 OpensearchSecurityPluginConfigArgs
    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 OpensearchSecurityPluginConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpensearchSecurityPluginConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpensearchSecurityPluginConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var opensearchSecurityPluginConfigResource = new Aiven.OpensearchSecurityPluginConfig("opensearchSecurityPluginConfigResource", new()
{
    AdminPassword = "string",
    Project = "string",
    ServiceName = "string",
    Timeouts = new Aiven.Inputs.OpensearchSecurityPluginConfigTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := aiven.NewOpensearchSecurityPluginConfig(ctx, "opensearchSecurityPluginConfigResource", &aiven.OpensearchSecurityPluginConfigArgs{
	AdminPassword: pulumi.String("string"),
	Project:       pulumi.String("string"),
	ServiceName:   pulumi.String("string"),
	Timeouts: &aiven.OpensearchSecurityPluginConfigTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var opensearchSecurityPluginConfigResource = new OpensearchSecurityPluginConfig("opensearchSecurityPluginConfigResource", OpensearchSecurityPluginConfigArgs.builder()
    .adminPassword("string")
    .project("string")
    .serviceName("string")
    .timeouts(OpensearchSecurityPluginConfigTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    opensearch_security_plugin_config_resource = aiven.OpensearchSecurityPluginConfig("opensearchSecurityPluginConfigResource",
    admin_password="string",
    project="string",
    service_name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const opensearchSecurityPluginConfigResource = new aiven.OpensearchSecurityPluginConfig("opensearchSecurityPluginConfigResource", {
    adminPassword: "string",
    project: "string",
    serviceName: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: aiven:OpensearchSecurityPluginConfig
properties:
    adminPassword: string
    project: string
    serviceName: string
    timeouts:
        create: string
        delete: string
        read: string
        update: string

    OpensearchSecurityPluginConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OpensearchSecurityPluginConfig resource accepts the following input properties:

    AdminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    Project string
    Project name. Changing this property forces recreation of the resource.
    ServiceName string
    Service name. Changing this property forces recreation of the resource.
    Timeouts OpensearchSecurityPluginConfigTimeouts
    AdminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    Project string
    Project name. Changing this property forces recreation of the resource.
    ServiceName string
    Service name. Changing this property forces recreation of the resource.
    Timeouts OpensearchSecurityPluginConfigTimeoutsArgs
    adminPassword String
    Current os-sec-admin password. Length must be between 8 and 256.
    project String
    Project name. Changing this property forces recreation of the resource.
    serviceName String
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeouts
    adminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    project string
    Project name. Changing this property forces recreation of the resource.
    serviceName string
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeouts
    admin_password str
    Current os-sec-admin password. Length must be between 8 and 256.
    project str
    Project name. Changing this property forces recreation of the resource.
    service_name str
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeoutsArgs
    adminPassword String
    Current os-sec-admin password. Length must be between 8 and 256.
    project String
    Project name. Changing this property forces recreation of the resource.
    serviceName String
    Service name. Changing this property forces recreation of the resource.
    timeouts Property Map

    Outputs

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

    AdminEnabled bool
    security plugin admin defined.
    Available bool
    Opensearch security available for the service.
    Enabled bool
    Opensearch security enabled for the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    AdminEnabled bool
    security plugin admin defined.
    Available bool
    Opensearch security available for the service.
    Enabled bool
    Opensearch security enabled for the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    adminEnabled Boolean
    security plugin admin defined.
    available Boolean
    Opensearch security available for the service.
    enabled Boolean
    Opensearch security enabled for the service.
    id String
    The provider-assigned unique ID for this managed resource.
    adminEnabled boolean
    security plugin admin defined.
    available boolean
    Opensearch security available for the service.
    enabled boolean
    Opensearch security enabled for the service.
    id string
    The provider-assigned unique ID for this managed resource.
    admin_enabled bool
    security plugin admin defined.
    available bool
    Opensearch security available for the service.
    enabled bool
    Opensearch security enabled for the service.
    id str
    The provider-assigned unique ID for this managed resource.
    adminEnabled Boolean
    security plugin admin defined.
    available Boolean
    Opensearch security available for the service.
    enabled Boolean
    Opensearch security enabled for the service.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OpensearchSecurityPluginConfig Resource

    Get an existing OpensearchSecurityPluginConfig 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?: OpensearchSecurityPluginConfigState, opts?: CustomResourceOptions): OpensearchSecurityPluginConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_enabled: Optional[bool] = None,
        admin_password: Optional[str] = None,
        available: Optional[bool] = None,
        enabled: Optional[bool] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        timeouts: Optional[OpensearchSecurityPluginConfigTimeoutsArgs] = None) -> OpensearchSecurityPluginConfig
    func GetOpensearchSecurityPluginConfig(ctx *Context, name string, id IDInput, state *OpensearchSecurityPluginConfigState, opts ...ResourceOption) (*OpensearchSecurityPluginConfig, error)
    public static OpensearchSecurityPluginConfig Get(string name, Input<string> id, OpensearchSecurityPluginConfigState? state, CustomResourceOptions? opts = null)
    public static OpensearchSecurityPluginConfig get(String name, Output<String> id, OpensearchSecurityPluginConfigState state, CustomResourceOptions options)
    resources:  _:    type: aiven:OpensearchSecurityPluginConfig    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdminEnabled bool
    security plugin admin defined.
    AdminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    Available bool
    Opensearch security available for the service.
    Enabled bool
    Opensearch security enabled for the service.
    Project string
    Project name. Changing this property forces recreation of the resource.
    ServiceName string
    Service name. Changing this property forces recreation of the resource.
    Timeouts OpensearchSecurityPluginConfigTimeouts
    AdminEnabled bool
    security plugin admin defined.
    AdminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    Available bool
    Opensearch security available for the service.
    Enabled bool
    Opensearch security enabled for the service.
    Project string
    Project name. Changing this property forces recreation of the resource.
    ServiceName string
    Service name. Changing this property forces recreation of the resource.
    Timeouts OpensearchSecurityPluginConfigTimeoutsArgs
    adminEnabled Boolean
    security plugin admin defined.
    adminPassword String
    Current os-sec-admin password. Length must be between 8 and 256.
    available Boolean
    Opensearch security available for the service.
    enabled Boolean
    Opensearch security enabled for the service.
    project String
    Project name. Changing this property forces recreation of the resource.
    serviceName String
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeouts
    adminEnabled boolean
    security plugin admin defined.
    adminPassword string
    Current os-sec-admin password. Length must be between 8 and 256.
    available boolean
    Opensearch security available for the service.
    enabled boolean
    Opensearch security enabled for the service.
    project string
    Project name. Changing this property forces recreation of the resource.
    serviceName string
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeouts
    admin_enabled bool
    security plugin admin defined.
    admin_password str
    Current os-sec-admin password. Length must be between 8 and 256.
    available bool
    Opensearch security available for the service.
    enabled bool
    Opensearch security enabled for the service.
    project str
    Project name. Changing this property forces recreation of the resource.
    service_name str
    Service name. Changing this property forces recreation of the resource.
    timeouts OpensearchSecurityPluginConfigTimeoutsArgs
    adminEnabled Boolean
    security plugin admin defined.
    adminPassword String
    Current os-sec-admin password. Length must be between 8 and 256.
    available Boolean
    Opensearch security available for the service.
    enabled Boolean
    Opensearch security enabled for the service.
    project String
    Project name. Changing this property forces recreation of the resource.
    serviceName String
    Service name. Changing this property forces recreation of the resource.
    timeouts Property Map

    Supporting Types

    OpensearchSecurityPluginConfigTimeouts, OpensearchSecurityPluginConfigTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default_ String
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default str
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default String
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    $ pulumi import aiven:index/opensearchSecurityPluginConfig:OpensearchSecurityPluginConfig example PROJECT/SERVICE_NAME

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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