Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kafka
  6. Acl
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kafka.Acl

volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Kafka ACL rule used to control permissions for specified SASL users to access Topic or Group resources from specified IPs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const example = new volcenginecc.kafka.Acl("example", {
    instanceId: "kafka-xxxxxx",
    userName: "*",
    ip: "*",
    resourceType: "Topic",
    patternType: "Literal",
    resource: "*",
    accessPolicy: "Write",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.kafka.Acl("example",
    instance_id="kafka-xxxxxx",
    user_name="*",
    ip="*",
    resource_type="Topic",
    pattern_type="Literal",
    resource="*",
    access_policy="Write")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/kafka"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.NewAcl(ctx, "example", &kafka.AclArgs{
			InstanceId:   pulumi.String("kafka-xxxxxx"),
			UserName:     pulumi.String("*"),
			Ip:           pulumi.String("*"),
			ResourceType: pulumi.String("Topic"),
			PatternType:  pulumi.String("Literal"),
			Resource:     pulumi.String("*"),
			AccessPolicy: pulumi.String("Write"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var example = new Volcenginecc.Kafka.Acl("example", new()
    {
        InstanceId = "kafka-xxxxxx",
        UserName = "*",
        Ip = "*",
        ResourceType = "Topic",
        PatternType = "Literal",
        Resource = "*",
        AccessPolicy = "Write",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.kafka.Acl;
import com.volcengine.volcenginecc.kafka.AclArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Acl("example", AclArgs.builder()
            .instanceId("kafka-xxxxxx")
            .userName("*")
            .ip("*")
            .resourceType("Topic")
            .patternType("Literal")
            .resource("*")
            .accessPolicy("Write")
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:kafka:Acl
    properties:
      instanceId: kafka-xxxxxx
      userName: '*'
      ip: '*'
      resourceType: Topic
      patternType: Literal
      resource: '*'
      accessPolicy: Write

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_kafka_acl" "example" {
  instance_id   = "kafka-xxxxxx"
  user_name     = "*"
  ip            = "*"
  resource_type = "Topic"
  pattern_type  = "Literal"
  resource      = "*"
  access_policy = "Write"
}

    Create Acl Resource

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

    Constructor syntax

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

@overload
def Acl(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        access_policy: Optional[str] = None,
        instance_id: Optional[str] = None,
        ip: Optional[str] = None,
        pattern_type: Optional[str] = None,
        resource: Optional[str] = None,
        resource_type: Optional[str] = None,
        user_name: Optional[str] = None)
    func NewAcl(ctx *Context, name string, args AclArgs, opts ...ResourceOption) (*Acl, error)
    public Acl(string name, AclArgs args, CustomResourceOptions? opts = null)
    public Acl(String name, AclArgs args)
public Acl(String name, AclArgs args, CustomResourceOptions options)

    type: volcenginecc:kafka:Acl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_kafka_acl" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AclArgs
    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 AclArgs
    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 AclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AclArgs
    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 exampleaclResourceResourceFromKafkaacl = new Volcenginecc.Kafka.Acl("exampleaclResourceResourceFromKafkaacl", new()
{
    AccessPolicy = "string",
    InstanceId = "string",
    Ip = "string",
    PatternType = "string",
    Resource = "string",
    ResourceType = "string",
    UserName = "string",
});

    example, err := kafka.NewAcl(ctx, "exampleaclResourceResourceFromKafkaacl", &kafka.AclArgs{
	AccessPolicy: pulumi.String("string"),
	InstanceId:   pulumi.String("string"),
	Ip:           pulumi.String("string"),
	PatternType:  pulumi.String("string"),
	Resource:     pulumi.String("string"),
	ResourceType: pulumi.String("string"),
	UserName:     pulumi.String("string"),
})

    resource "volcenginecc_kafka_acl" "exampleaclResourceResourceFromKafkaacl" {
  lifecycle {
    create_before_destroy = true
  }
  access_policy = "string"
  instance_id   = "string"
  ip            = "string"
  pattern_type  = "string"
  resource      = "string"
  resource_type = "string"
  user_name     = "string"
}

    var exampleaclResourceResourceFromKafkaacl = new com.volcengine.volcenginecc.kafka.Acl("exampleaclResourceResourceFromKafkaacl", com.volcengine.volcenginecc.kafka.AclArgs.builder()
    .accessPolicy("string")
    .instanceId("string")
    .ip("string")
    .patternType("string")
    .resource("string")
    .resourceType("string")
    .userName("string")
    .build());

    exampleacl_resource_resource_from_kafkaacl = volcenginecc.kafka.Acl("exampleaclResourceResourceFromKafkaacl",
    access_policy="string",
    instance_id="string",
    ip="string",
    pattern_type="string",
    resource="string",
    resource_type="string",
    user_name="string")

    const exampleaclResourceResourceFromKafkaacl = new volcenginecc.kafka.Acl("exampleaclResourceResourceFromKafkaacl", {
    accessPolicy: "string",
    instanceId: "string",
    ip: "string",
    patternType: "string",
    resource: "string",
    resourceType: "string",
    userName: "string",
});

    type: volcenginecc:kafka:Acl
properties:
    accessPolicy: string
    instanceId: string
    ip: string
    patternType: string
    resource: string
    resourceType: string
    userName: string

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

    AccessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    InstanceId string
    Instance ID for the ACL to be created.
    Ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    PatternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    Resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    ResourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    UserName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    AccessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    InstanceId string
    Instance ID for the ACL to be created.
    Ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    PatternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    Resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    ResourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    UserName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    access_policy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instance_id string
    Instance ID for the ACL to be created.
    ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    pattern_type string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    resource_type string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    user_name string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy String
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId String
    Instance ID for the ACL to be created.
    ip String
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType String
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource String
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType String
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName String
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId string
    Instance ID for the ACL to be created.
    ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    access_policy str
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instance_id str
    Instance ID for the ACL to be created.
    ip str
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    pattern_type str
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource str
    Name or prefix of the Topic or Group resource bound to the rule.
    resource_type str
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    user_name str
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy String
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId String
    Instance ID for the ACL to be created.
    ip String
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType String
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource String
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType String
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName String
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Acl 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 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 Acl Resource

    Get an existing Acl 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?: AclState, opts?: CustomResourceOptions): Acl
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_policy: Optional[str] = None,
        instance_id: Optional[str] = None,
        ip: Optional[str] = None,
        pattern_type: Optional[str] = None,
        resource: Optional[str] = None,
        resource_type: Optional[str] = None,
        user_name: Optional[str] = None) -> Acl
    func GetAcl(ctx *Context, name string, id IDInput, state *AclState, opts ...ResourceOption) (*Acl, error)
    public static Acl Get(string name, Input<string> id, AclState? state, CustomResourceOptions? opts = null)
    public static Acl get(String name, Output<String> id, AclState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:kafka:Acl    get:      id: ${id}
    import {
  to = volcenginecc_kafka_acl.example
  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:
    AccessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    InstanceId string
    Instance ID for the ACL to be created.
    Ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    PatternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    Resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    ResourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    UserName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    AccessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    InstanceId string
    Instance ID for the ACL to be created.
    Ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    PatternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    Resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    ResourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    UserName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    access_policy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instance_id string
    Instance ID for the ACL to be created.
    ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    pattern_type string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    resource_type string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    user_name string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy String
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId String
    Instance ID for the ACL to be created.
    ip String
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType String
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource String
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType String
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName String
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy string
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId string
    Instance ID for the ACL to be created.
    ip string
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType string
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource string
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType string
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName string
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    access_policy str
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instance_id str
    Instance ID for the ACL to be created.
    ip str
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    pattern_type str
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource str
    Name or prefix of the Topic or Group resource bound to the rule.
    resource_type str
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    user_name str
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.
    accessPolicy String
    Access policy for the rule. Read grants read permission; Write grants write permission. Only one value is allowed—if multiple are provided, only the first takes effect.
    instanceId String
    Instance ID for the ACL to be created.
    ip String
    IP address or subnet allowed by the rule. Supports specifying '*', which allows access from any IP. Separate multiple IPs with ','.
    patternType String
    Rule matching method. Literal: exact match; Prefixed: prefix match.
    resource String
    Name or prefix of the Topic or Group resource bound to the rule.
    resourceType String
    Resource type bound to the rule. Supports configuring 'Topic' or 'Group'.
    userName String
    SASL users allowed by the rule. Supports specifying '*', which allows access for any user.

    Import

    $ pulumi import volcenginecc:kafka/acl:Acl example "instance_id|user_name|ip|resource_type|pattern_type|resource|access_policy"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.60
    published on Thursday, Sep 3, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial