1. Packages
  2. Aiven
  3. API Docs
  4. getKafkaAcl
Aiven v6.17.2 published on Thursday, Jun 6, 2024 by Pulumi

aiven.getKafkaAcl

Explore with Pulumi AI

aiven logo
Aiven v6.17.2 published on Thursday, Jun 6, 2024 by Pulumi

    The Data Source Kafka ACL data source provides information about the existing Aiven Kafka ACL for a Kafka service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const mytestacl = aiven.getKafkaAcl({
        project: myproject.project,
        serviceName: mykafka.serviceName,
        topic: "<TOPIC_NAME_PATTERN>",
        permission: "<PERMISSON>",
        username: "<USERNAME_PATTERN>",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    mytestacl = aiven.get_kafka_acl(project=myproject["project"],
        service_name=mykafka["serviceName"],
        topic="<TOPIC_NAME_PATTERN>",
        permission="<PERMISSON>",
        username="<USERNAME_PATTERN>")
    
    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.LookupKafkaAcl(ctx, &aiven.LookupKafkaAclArgs{
    			Project:     myproject.Project,
    			ServiceName: mykafka.ServiceName,
    			Topic:       "<TOPIC_NAME_PATTERN>",
    			Permission:  "<PERMISSON>",
    			Username:    "<USERNAME_PATTERN>",
    		}, 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 mytestacl = Aiven.GetKafkaAcl.Invoke(new()
        {
            Project = myproject.Project,
            ServiceName = mykafka.ServiceName,
            Topic = "<TOPIC_NAME_PATTERN>",
            Permission = "<PERMISSON>",
            Username = "<USERNAME_PATTERN>",
        });
    
    });
    
    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.GetKafkaAclArgs;
    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 mytestacl = AivenFunctions.getKafkaAcl(GetKafkaAclArgs.builder()
                .project(myproject.project())
                .serviceName(mykafka.serviceName())
                .topic("<TOPIC_NAME_PATTERN>")
                .permission("<PERMISSON>")
                .username("<USERNAME_PATTERN>")
                .build());
    
        }
    }
    
    variables:
      mytestacl:
        fn::invoke:
          Function: aiven:getKafkaAcl
          Arguments:
            project: ${myproject.project}
            serviceName: ${mykafka.serviceName}
            topic: <TOPIC_NAME_PATTERN>
            permission: <PERMISSON>
            username: <USERNAME_PATTERN>
    

    Using getKafkaAcl

    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 getKafkaAcl(args: GetKafkaAclArgs, opts?: InvokeOptions): Promise<GetKafkaAclResult>
    function getKafkaAclOutput(args: GetKafkaAclOutputArgs, opts?: InvokeOptions): Output<GetKafkaAclResult>
    def get_kafka_acl(permission: Optional[str] = None,
                      project: Optional[str] = None,
                      service_name: Optional[str] = None,
                      topic: Optional[str] = None,
                      username: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKafkaAclResult
    def get_kafka_acl_output(permission: Optional[pulumi.Input[str]] = None,
                      project: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      topic: Optional[pulumi.Input[str]] = None,
                      username: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKafkaAclResult]
    func LookupKafkaAcl(ctx *Context, args *LookupKafkaAclArgs, opts ...InvokeOption) (*LookupKafkaAclResult, error)
    func LookupKafkaAclOutput(ctx *Context, args *LookupKafkaAclOutputArgs, opts ...InvokeOption) LookupKafkaAclResultOutput

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

    public static class GetKafkaAcl 
    {
        public static Task<GetKafkaAclResult> InvokeAsync(GetKafkaAclArgs args, InvokeOptions? opts = null)
        public static Output<GetKafkaAclResult> Invoke(GetKafkaAclInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKafkaAclResult> getKafkaAcl(GetKafkaAclArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aiven:index/getKafkaAcl:getKafkaAcl
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    Topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    Username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    Permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    Topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    Username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    permission String
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic String
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username String
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    permission str
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic str
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username str
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    permission String
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic String
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username String
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.

    getKafkaAcl Result

    The following output properties are available:

    AclId string
    Kafka ACL ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    Topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    Username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    AclId string
    Kafka ACL ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    Topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    Username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    aclId String
    Kafka ACL ID
    id String
    The provider-assigned unique ID for this managed resource.
    permission String
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic String
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username String
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    aclId string
    Kafka ACL ID
    id string
    The provider-assigned unique ID for this managed resource.
    permission string
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic string
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username string
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    acl_id str
    Kafka ACL ID
    id str
    The provider-assigned unique ID for this managed resource.
    permission str
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic str
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username str
    Username pattern for the ACL entry. Changing this property forces recreation of the resource.
    aclId String
    Kafka ACL ID
    id String
    The provider-assigned unique ID for this managed resource.
    permission String
    Kafka permission to grant. The possible values are admin, read, readwrite and write. 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.
    topic String
    Topic name pattern for the ACL entry. Changing this property forces recreation of the resource.
    username String
    Username pattern for the ACL entry. 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
    Aiven v6.17.2 published on Thursday, Jun 6, 2024 by Pulumi