1. Packages
  2. Volcengine
  3. API Docs
  4. kafka
  5. getAllowLists
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.kafka.getAllowLists

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of kafka allow lists

    Example Usage

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

const foo = volcengine.kafka.getAllowLists({
    instanceId: "kafka-xxx",
    regionId: "cn-beijing",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.kafka.get_allow_lists(instance_id="kafka-xxx",
    region_id="cn-beijing")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.GetAllowLists(ctx, &kafka.GetAllowListsArgs{
			InstanceId: pulumi.StringRef("kafka-xxx"),
			RegionId:   "cn-beijing",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Kafka.GetAllowLists.Invoke(new()
    {
        InstanceId = "kafka-xxx",
        RegionId = "cn-beijing",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.kafka.KafkaFunctions;
import com.pulumi.volcengine.kafka.inputs.GetAllowListsArgs;
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 foo = KafkaFunctions.getAllowLists(GetAllowListsArgs.builder()
            .instanceId("kafka-xxx")
            .regionId("cn-beijing")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:kafka:getAllowLists
      Arguments:
        instanceId: kafka-xxx
        regionId: cn-beijing

    Using getAllowLists

    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 getAllowLists(args: GetAllowListsArgs, opts?: InvokeOptions): Promise<GetAllowListsResult>
function getAllowListsOutput(args: GetAllowListsOutputArgs, opts?: InvokeOptions): Output<GetAllowListsResult>
    def get_allow_lists(instance_id: Optional[str] = None,
                    output_file: Optional[str] = None,
                    region_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAllowListsResult
def get_allow_lists_output(instance_id: Optional[pulumi.Input[str]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    region_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAllowListsResult]
    func GetAllowLists(ctx *Context, args *GetAllowListsArgs, opts ...InvokeOption) (*GetAllowListsResult, error)
func GetAllowListsOutput(ctx *Context, args *GetAllowListsOutputArgs, opts ...InvokeOption) GetAllowListsResultOutput

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

    public static class GetAllowLists 
{
    public static Task<GetAllowListsResult> InvokeAsync(GetAllowListsArgs args, InvokeOptions? opts = null)
    public static Output<GetAllowListsResult> Invoke(GetAllowListsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAllowListsResult> getAllowLists(GetAllowListsArgs args, InvokeOptions options)
public static Output<GetAllowListsResult> getAllowLists(GetAllowListsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:kafka/getAllowLists:getAllowLists
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RegionId string
    The region ID.
    InstanceId string
    The instance ID to query.
    OutputFile string
    File name where to save data source results.
    RegionId string
    The region ID.
    InstanceId string
    The instance ID to query.
    OutputFile string
    File name where to save data source results.
    regionId String
    The region ID.
    instanceId String
    The instance ID to query.
    outputFile String
    File name where to save data source results.
    regionId string
    The region ID.
    instanceId string
    The instance ID to query.
    outputFile string
    File name where to save data source results.
    region_id str
    The region ID.
    instance_id str
    The instance ID to query.
    output_file str
    File name where to save data source results.
    regionId String
    The region ID.
    instanceId String
    The instance ID to query.
    outputFile String
    File name where to save data source results.

    getAllowLists Result

    The following output properties are available:

    AllowLists List<GetAllowListsAllowList>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    TotalCount int
    The total count of query.
    InstanceId string
    The id of the instance.
    OutputFile string
    AllowLists []GetAllowListsAllowList
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    TotalCount int
    The total count of query.
    InstanceId string
    The id of the instance.
    OutputFile string
    allowLists List<GetAllowListsAllowList>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    totalCount Integer
    The total count of query.
    instanceId String
    The id of the instance.
    outputFile String
    allowLists GetAllowListsAllowList[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    totalCount number
    The total count of query.
    instanceId string
    The id of the instance.
    outputFile string
    allow_lists Sequence[GetAllowListsAllowList]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    total_count int
    The total count of query.
    instance_id str
    The id of the instance.
    output_file str
    allowLists List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    totalCount Number
    The total count of query.
    instanceId String
    The id of the instance.
    outputFile String

    Supporting Types

    GetAllowListsAllowList

    AllowListDesc string
    The description of the allow list.
    AllowListId string
    The id of the allow list.
    AllowListIpNum int
    The number of rules specified in the whitelist.
    AllowListName string
    The name of the allow list.
    AllowLists List<string>
    Whitelist rule list.
    AssociatedInstanceNum int
    The number of instances bound to the whitelist.
    AssociatedInstances List<GetAllowListsAllowListAssociatedInstance>
    The list of associated instances.
    AllowListDesc string
    The description of the allow list.
    AllowListId string
    The id of the allow list.
    AllowListIpNum int
    The number of rules specified in the whitelist.
    AllowListName string
    The name of the allow list.
    AllowLists []string
    Whitelist rule list.
    AssociatedInstanceNum int
    The number of instances bound to the whitelist.
    AssociatedInstances []GetAllowListsAllowListAssociatedInstance
    The list of associated instances.
    allowListDesc String
    The description of the allow list.
    allowListId String
    The id of the allow list.
    allowListIpNum Integer
    The number of rules specified in the whitelist.
    allowListName String
    The name of the allow list.
    allowLists List<String>
    Whitelist rule list.
    associatedInstanceNum Integer
    The number of instances bound to the whitelist.
    associatedInstances List<GetAllowListsAllowListAssociatedInstance>
    The list of associated instances.
    allowListDesc string
    The description of the allow list.
    allowListId string
    The id of the allow list.
    allowListIpNum number
    The number of rules specified in the whitelist.
    allowListName string
    The name of the allow list.
    allowLists string[]
    Whitelist rule list.
    associatedInstanceNum number
    The number of instances bound to the whitelist.
    associatedInstances GetAllowListsAllowListAssociatedInstance[]
    The list of associated instances.
    allow_list_desc str
    The description of the allow list.
    allow_list_id str
    The id of the allow list.
    allow_list_ip_num int
    The number of rules specified in the whitelist.
    allow_list_name str
    The name of the allow list.
    allow_lists Sequence[str]
    Whitelist rule list.
    associated_instance_num int
    The number of instances bound to the whitelist.
    associated_instances Sequence[GetAllowListsAllowListAssociatedInstance]
    The list of associated instances.
    allowListDesc String
    The description of the allow list.
    allowListId String
    The id of the allow list.
    allowListIpNum Number
    The number of rules specified in the whitelist.
    allowListName String
    The name of the allow list.
    allowLists List<String>
    Whitelist rule list.
    associatedInstanceNum Number
    The number of instances bound to the whitelist.
    associatedInstances List<Property Map>
    The list of associated instances.

    GetAllowListsAllowListAssociatedInstance

    InstanceId string
    The instance ID to query.
    InstanceName string
    The name of the instance.
    InstanceId string
    The instance ID to query.
    InstanceName string
    The name of the instance.
    instanceId String
    The instance ID to query.
    instanceName String
    The name of the instance.
    instanceId string
    The instance ID to query.
    instanceName string
    The name of the instance.
    instance_id str
    The instance ID to query.
    instance_name str
    The name of the instance.
    instanceId String
    The instance ID to query.
    instanceName String
    The name of the instance.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate