Aiven

v5.4.0 published on Monday, Sep 12, 2022 by Pulumi

getKafkaAcl

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var mytestacl = Aiven.GetKafkaAcl.Invoke(new()
    {
        Project = aiven_project.Myproject.Project,
        ServiceName = aiven_service.Myservice.Service_name,
        Topic = "<TOPIC_NAME_PATTERN>",
        Permission = "<PERMISSON>",
        Username = "<USERNAME_PATTERN>",
    });

});

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.LookupKafkaAcl(ctx, &GetKafkaAclArgs{
			Project:     aiven_project.Myproject.Project,
			ServiceName: aiven_service.Myservice.Service_name,
			Topic:       "<TOPIC_NAME_PATTERN>",
			Permission:  "<PERMISSON>",
			Username:    "<USERNAME_PATTERN>",
		}, 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.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(aiven_project.myproject().project())
            .serviceName(aiven_service.myservice().service_name())
            .topic("<TOPIC_NAME_PATTERN>")
            .permission("<PERMISSON>")
            .username("<USERNAME_PATTERN>")
            .build());

    }
}

import pulumi
import pulumi_aiven as aiven

mytestacl = aiven.get_kafka_acl(project=aiven_project["myproject"]["project"],
    service_name=aiven_service["myservice"]["service_name"],
    topic="<TOPIC_NAME_PATTERN>",
    permission="<PERMISSON>",
    username="<USERNAME_PATTERN>")

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

const mytestacl = aiven.getKafkaAcl({
    project: aiven_project.myproject.project,
    serviceName: aiven_service.myservice.service_name,
    topic: "<TOPIC_NAME_PATTERN>",
    permission: "<PERMISSON>",
    username: "<USERNAME_PATTERN>",
});

variables:
  mytestacl:
    Fn::Invoke:
      Function: aiven:getKafkaAcl
      Arguments:
        project: ${aiven_project.myproject.project}
        serviceName: ${aiven_service.myservice.service_name}
        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. This property cannot be changed, doing so forces recreation of the resource.
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.
Topic string: Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.
Username string: Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.

Permission string: Kafka permission to grant. The possible values are admin, read, readwrite and write. This property cannot be changed, doing so forces recreation of the resource.
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.
Topic string: Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.
Username string: Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.

permission String: Kafka permission to grant. The possible values are admin, read, readwrite and write. This property cannot be changed, doing so forces recreation of the resource.
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.
topic String: Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.
username String: Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.

permission string: Kafka permission to grant. The possible values are admin, read, readwrite and write. This property cannot be changed, doing so forces recreation of the resource.
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.
topic string: Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.
username string: Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.

permission str: Kafka permission to grant. The possible values are admin, read, readwrite and write. This property cannot be changed, doing so forces recreation of the resource.
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.
topic str: Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.
username str: Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource.

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

Package Details

Repository: https://github.com/pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.