1. Packages
  2. Aiven Provider
  3. API Docs
  4. ElasticSearchAcl
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

aiven.ElasticSearchAcl

aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

    This resource is deprecated, please use aiven.ElasticSearchAclConfigand aiven.ElasticSearchAclRule

    The Elasticsearch ACL resource allows the creation and management of ACLs for an Aiven Elasticsearch service.

    Example Usage

    using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var es_acls = new Aiven.ElasticSearchAcl("es-acls", new Aiven.ElasticSearchAclArgs
        {
            Project = aiven_project.Es_project.Project,
            ServiceName = aiven_service.Es.Service_name,
            Enabled = true,
            ExtendedAcl = false,
            Acls = 
            {
                new Aiven.Inputs.ElasticSearchAclAclArgs
                {
                    Username = aiven_service_user.Es_user.Username,
                    Rules = 
                    {
                        new Aiven.Inputs.ElasticSearchAclAclRuleArgs
                        {
                            Index = "_*",
                            Permission = "admin",
                        },
                        new Aiven.Inputs.ElasticSearchAclAclRuleArgs
                        {
                            Index = "*",
                            Permission = "admin",
                        },
                    },
                },
                new Aiven.Inputs.ElasticSearchAclAclArgs
                {
                    Username = "avnadmin",
                    Rules = 
                    {
                        new Aiven.Inputs.ElasticSearchAclAclRuleArgs
                        {
                            Index = "_*",
                            Permission = "read",
                        },
                        new Aiven.Inputs.ElasticSearchAclAclRuleArgs
                        {
                            Index = "*",
                            Permission = "read",
                        },
                    },
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v4/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewElasticSearchAcl(ctx, "es-acls", &aiven.ElasticSearchAclArgs{
			Project:     pulumi.Any(aiven_project.Es - project.Project),
			ServiceName: pulumi.Any(aiven_service.Es.Service_name),
			Enabled:     pulumi.Bool(true),
			ExtendedAcl: pulumi.Bool(false),
			Acls: ElasticSearchAclAclArray{
				&ElasticSearchAclAclArgs{
					Username: pulumi.Any(aiven_service_user.Es - user.Username),
					Rules: ElasticSearchAclAclRuleArray{
						&ElasticSearchAclAclRuleArgs{
							Index:      pulumi.String("_*"),
							Permission: pulumi.String("admin"),
						},
						&ElasticSearchAclAclRuleArgs{
							Index:      pulumi.String("*"),
							Permission: pulumi.String("admin"),
						},
					},
				},
				&ElasticSearchAclAclArgs{
					Username: pulumi.String("avnadmin"),
					Rules: ElasticSearchAclAclRuleArray{
						&ElasticSearchAclAclRuleArgs{
							Index:      pulumi.String("_*"),
							Permission: pulumi.String("read"),
						},
						&ElasticSearchAclAclRuleArgs{
							Index:      pulumi.String("*"),
							Permission: pulumi.String("read"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const es_acls = new aiven.ElasticSearchAcl("es-acls", {
    project: aiven_project["es-project"].project,
    serviceName: aiven_service.es.service_name,
    enabled: true,
    extendedAcl: false,
    acls: [
        {
            username: aiven_service_user["es-user"].username,
            rules: [
                {
                    index: "_*",
                    permission: "admin",
                },
                {
                    index: "*",
                    permission: "admin",
                },
            ],
        },
        {
            username: "avnadmin",
            rules: [
                {
                    index: "_*",
                    permission: "read",
                },
                {
                    index: "*",
                    permission: "read",
                },
            ],
        },
    ],
});

    import pulumi
import pulumi_aiven as aiven

es_acls = aiven.ElasticSearchAcl("es-acls",
    project=aiven_project["es-project"]["project"],
    service_name=aiven_service["es"]["service_name"],
    enabled=True,
    extended_acl=False,
    acls=[
        aiven.ElasticSearchAclAclArgs(
            username=aiven_service_user["es-user"]["username"],
            rules=[
                aiven.ElasticSearchAclAclRuleArgs(
                    index="_*",
                    permission="admin",
                ),
                aiven.ElasticSearchAclAclRuleArgs(
                    index="*",
                    permission="admin",
                ),
            ],
        ),
        aiven.ElasticSearchAclAclArgs(
            username="avnadmin",
            rules=[
                aiven.ElasticSearchAclAclRuleArgs(
                    index="_*",
                    permission="read",
                ),
                aiven.ElasticSearchAclAclRuleArgs(
                    index="*",
                    permission="read",
                ),
            ],
        ),
    ])

    Example coming soon!

    Create ElasticSearchAcl Resource

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

    Constructor syntax

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

@overload
def ElasticSearchAcl(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     project: Optional[str] = None,
                     service_name: Optional[str] = None,
                     acls: Optional[Sequence[ElasticSearchAclAclArgs]] = None,
                     enabled: Optional[bool] = None,
                     extended_acl: Optional[bool] = None)
    func NewElasticSearchAcl(ctx *Context, name string, args ElasticSearchAclArgs, opts ...ResourceOption) (*ElasticSearchAcl, error)
    public ElasticSearchAcl(string name, ElasticSearchAclArgs args, CustomResourceOptions? opts = null)
    public ElasticSearchAcl(String name, ElasticSearchAclArgs args)
public ElasticSearchAcl(String name, ElasticSearchAclArgs args, CustomResourceOptions options)

    type: aiven:ElasticSearchAcl
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 ElasticSearchAclArgs
    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 ElasticSearchAclArgs
    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 ElasticSearchAclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticSearchAclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticSearchAclArgs
    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 elasticSearchAclResource = new Aiven.ElasticSearchAcl("elasticSearchAclResource", new()
{
    Project = "string",
    ServiceName = "string",
    Acls = new[]
    {
        new Aiven.Inputs.ElasticSearchAclAclArgs
        {
            Rules = new[]
            {
                new Aiven.Inputs.ElasticSearchAclAclRuleArgs
                {
                    Index = "string",
                    Permission = "string",
                },
            },
            Username = "string",
        },
    },
    Enabled = false,
    ExtendedAcl = false,
});

    example, err := aiven.NewElasticSearchAcl(ctx, "elasticSearchAclResource", &aiven.ElasticSearchAclArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Acls: aiven.ElasticSearchAclAclArray{
		&aiven.ElasticSearchAclAclArgs{
			Rules: aiven.ElasticSearchAclAclRuleArray{
				&aiven.ElasticSearchAclAclRuleArgs{
					Index:      pulumi.String("string"),
					Permission: pulumi.String("string"),
				},
			},
			Username: pulumi.String("string"),
		},
	},
	Enabled:     pulumi.Bool(false),
	ExtendedAcl: pulumi.Bool(false),
})

    var elasticSearchAclResource = new ElasticSearchAcl("elasticSearchAclResource", ElasticSearchAclArgs.builder()
    .project("string")
    .serviceName("string")
    .acls(ElasticSearchAclAclArgs.builder()
        .rules(ElasticSearchAclAclRuleArgs.builder()
            .index("string")
            .permission("string")
            .build())
        .username("string")
        .build())
    .enabled(false)
    .extendedAcl(false)
    .build());

    elastic_search_acl_resource = aiven.ElasticSearchAcl("elasticSearchAclResource",
    project="string",
    service_name="string",
    acls=[{
        "rules": [{
            "index": "string",
            "permission": "string",
        }],
        "username": "string",
    }],
    enabled=False,
    extended_acl=False)

    const elasticSearchAclResource = new aiven.ElasticSearchAcl("elasticSearchAclResource", {
    project: "string",
    serviceName: "string",
    acls: [{
        rules: [{
            index: "string",
            permission: "string",
        }],
        username: "string",
    }],
    enabled: false,
    extendedAcl: false,
});

    type: aiven:ElasticSearchAcl
properties:
    acls:
        - rules:
            - index: string
              permission: string
          username: string
    enabled: false
    extendedAcl: false
    project: string
    serviceName: string

    ElasticSearchAcl 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 ElasticSearchAcl resource accepts the following input properties:

    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 name of the service that 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.
    Acls List<ElasticSearchAclAcl>
    List of Elasticsearch ACLs
    Enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    ExtendedAcl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    Acls []ElasticSearchAclAclArgs
    List of Elasticsearch ACLs
    Enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    ExtendedAcl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls List<ElasticSearchAclAcl>
    List of Elasticsearch ACLs
    enabled Boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl Boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls ElasticSearchAclAcl[]
    List of Elasticsearch ACLs
    enabled boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls Sequence[ElasticSearchAclAclArgs]
    List of Elasticsearch ACLs
    enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extended_acl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls List<Property Map>
    List of Elasticsearch ACLs
    enabled Boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl Boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ElasticSearchAcl Resource

    Get an existing ElasticSearchAcl 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?: ElasticSearchAclState, opts?: CustomResourceOptions): ElasticSearchAcl
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acls: Optional[Sequence[ElasticSearchAclAclArgs]] = None,
        enabled: Optional[bool] = None,
        extended_acl: Optional[bool] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None) -> ElasticSearchAcl
    func GetElasticSearchAcl(ctx *Context, name string, id IDInput, state *ElasticSearchAclState, opts ...ResourceOption) (*ElasticSearchAcl, error)
    public static ElasticSearchAcl Get(string name, Input<string> id, ElasticSearchAclState? state, CustomResourceOptions? opts = null)
    public static ElasticSearchAcl get(String name, Output<String> id, ElasticSearchAclState state, CustomResourceOptions options)
    resources:  _:    type: aiven:ElasticSearchAcl    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:
    Acls List<ElasticSearchAclAcl>
    List of Elasticsearch ACLs
    Enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    ExtendedAcl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    Acls []ElasticSearchAclAclArgs
    List of Elasticsearch ACLs
    Enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    ExtendedAcl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls List<ElasticSearchAclAcl>
    List of Elasticsearch ACLs
    enabled Boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl Boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls ElasticSearchAclAcl[]
    List of Elasticsearch ACLs
    enabled boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls Sequence[ElasticSearchAclAclArgs]
    List of Elasticsearch ACLs
    enabled bool
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extended_acl bool
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.
    acls List<Property Map>
    List of Elasticsearch ACLs
    enabled Boolean
    Enable Elasticsearch ACLs. When disabled authenticated service users have unrestricted access. The default value is true.
    extendedAcl Boolean
    Index rules can be applied in a limited fashion to the _mget, _msearch and _bulk APIs (and only those) by enabling the ExtendedAcl option for the service. When it is enabled, users can use these APIs as long as all operations only target indexes they have been granted access to. The default value is true.
    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 name of the service that 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.

    Supporting Types

    ElasticSearchAclAcl, ElasticSearchAclAclArgs

    Rules List<ElasticSearchAclAclRule>
    Elasticsearch rules.
    Username string
    Username for the ACL entry. Maximum Length: 40.
    Rules []ElasticSearchAclAclRule
    Elasticsearch rules.
    Username string
    Username for the ACL entry. Maximum Length: 40.
    rules List<ElasticSearchAclAclRule>
    Elasticsearch rules.
    username String
    Username for the ACL entry. Maximum Length: 40.
    rules ElasticSearchAclAclRule[]
    Elasticsearch rules.
    username string
    Username for the ACL entry. Maximum Length: 40.
    rules Sequence[ElasticSearchAclAclRule]
    Elasticsearch rules.
    username str
    Username for the ACL entry. Maximum Length: 40.
    rules List<Property Map>
    Elasticsearch rules.
    username String
    Username for the ACL entry. Maximum Length: 40.

    ElasticSearchAclAclRule, ElasticSearchAclAclRuleArgs

    Index string
    Permission string
    Index string
    Permission string
    index String
    permission String
    index string
    permission string
    index String
    permission String

    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 v4.5.2 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.