1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getOpenSearchAclRule
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The Opensearch ACL Rule data source provides information about an existing Aiven Opensearch ACL Rule.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var osAclRule = Aiven.GetOpenSearchAclRule.Invoke(new()
        {
            Project = aiven_opensearch_acl_config.Os_acls_config.Project,
            ServiceName = aiven_opensearch_acl_config.Os_acls_config.Service_name,
            Username = "<USERNAME>",
            Index = "<INDEX>",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v5/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupOpenSearchAclRule(ctx, &aiven.LookupOpenSearchAclRuleArgs{
    			Project:     aiven_opensearch_acl_config.Os_acls_config.Project,
    			ServiceName: aiven_opensearch_acl_config.Os_acls_config.Service_name,
    			Username:    "<USERNAME>",
    			Index:       "<INDEX>",
    		}, nil)
    		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.AivenFunctions;
    import com.pulumi.aiven.inputs.GetOpenSearchAclRuleArgs;
    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 osAclRule = AivenFunctions.getOpenSearchAclRule(GetOpenSearchAclRuleArgs.builder()
                .project(aiven_opensearch_acl_config.os_acls_config().project())
                .serviceName(aiven_opensearch_acl_config.os_acls_config().service_name())
                .username("<USERNAME>")
                .index("<INDEX>")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const osAclRule = aiven.getOpenSearchAclRule({
        project: aiven_opensearch_acl_config.os_acls_config.project,
        serviceName: aiven_opensearch_acl_config.os_acls_config.service_name,
        username: "<USERNAME>",
        index: "<INDEX>",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    os_acl_rule = aiven.get_open_search_acl_rule(project=aiven_opensearch_acl_config["os_acls_config"]["project"],
        service_name=aiven_opensearch_acl_config["os_acls_config"]["service_name"],
        username="<USERNAME>",
        index="<INDEX>")
    
    variables:
      osAclRule:
        fn::invoke:
          Function: aiven:getOpenSearchAclRule
          Arguments:
            project: ${aiven_opensearch_acl_config.os_acls_config.project}
            serviceName: ${aiven_opensearch_acl_config.os_acls_config.service_name}
            username: <USERNAME>
            index: <INDEX>
    

    Using getOpenSearchAclRule

    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 getOpenSearchAclRule(args: GetOpenSearchAclRuleArgs, opts?: InvokeOptions): Promise<GetOpenSearchAclRuleResult>
    function getOpenSearchAclRuleOutput(args: GetOpenSearchAclRuleOutputArgs, opts?: InvokeOptions): Output<GetOpenSearchAclRuleResult>
    def get_open_search_acl_rule(index: Optional[str] = None,
                                 permission: Optional[str] = None,
                                 project: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 username: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetOpenSearchAclRuleResult
    def get_open_search_acl_rule_output(index: Optional[pulumi.Input[str]] = None,
                                 permission: Optional[pulumi.Input[str]] = None,
                                 project: Optional[pulumi.Input[str]] = None,
                                 service_name: Optional[pulumi.Input[str]] = None,
                                 username: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetOpenSearchAclRuleResult]
    func LookupOpenSearchAclRule(ctx *Context, args *LookupOpenSearchAclRuleArgs, opts ...InvokeOption) (*LookupOpenSearchAclRuleResult, error)
    func LookupOpenSearchAclRuleOutput(ctx *Context, args *LookupOpenSearchAclRuleOutputArgs, opts ...InvokeOption) LookupOpenSearchAclRuleResultOutput

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

    public static class GetOpenSearchAclRule 
    {
        public static Task<GetOpenSearchAclRuleResult> InvokeAsync(GetOpenSearchAclRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetOpenSearchAclRuleResult> Invoke(GetOpenSearchAclRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOpenSearchAclRuleResult> getOpenSearchAclRule(GetOpenSearchAclRuleArgs args, InvokeOptions options)
    public static Output<GetOpenSearchAclRuleResult> getOpenSearchAclRule(GetOpenSearchAclRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getOpenSearchAclRule:getOpenSearchAclRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    Permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    Username string
    The username for the ACL entry Maximum Length: 40. 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.
    Index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    Permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    Username string
    The username for the ACL entry Maximum Length: 40. 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.
    index String
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission String
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username String
    The username for the ACL entry Maximum Length: 40. 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.
    index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username string
    The username for the ACL entry Maximum Length: 40. 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.
    index str
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission str
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username str
    The username for the ACL entry Maximum Length: 40. 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.
    index String
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission String
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username String
    The username for the ACL entry Maximum Length: 40. 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.

    getOpenSearchAclRule Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    Permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    Username string
    The username for the ACL entry Maximum Length: 40. 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    Permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    Username string
    The username for the ACL entry Maximum Length: 40. 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.
    id String
    The provider-assigned unique ID for this managed resource.
    index String
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission String
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username String
    The username for the ACL entry Maximum Length: 40. 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.
    id string
    The provider-assigned unique ID for this managed resource.
    index string
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission string
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username string
    The username for the ACL entry Maximum Length: 40. 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.
    id str
    The provider-assigned unique ID for this managed resource.
    index str
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission str
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username str
    The username for the ACL entry Maximum Length: 40. 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.
    id String
    The provider-assigned unique ID for this managed resource.
    index String
    The index pattern for this ACL entry. Maximum Length: 249. This property cannot be changed, doing so forces recreation of the resource.
    permission String
    The permissions for this ACL entry The possible values are deny, admin, read, readwrite and write.
    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.
    username String
    The username for the ACL entry Maximum Length: 40. 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.

    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 v5.6.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.