1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kafka
  5. getAllowList
Viewing docs for bytepluscc v0.0.23
published on Thursday, Apr 16, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kafka.getAllowList

bytepluscc logo
Viewing docs for bytepluscc v0.0.23
published on Thursday, Apr 16, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::AllowList

    Using getAllowList

    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 getAllowList(args: GetAllowListArgs, opts?: InvokeOptions): Promise<GetAllowListResult>
function getAllowListOutput(args: GetAllowListOutputArgs, opts?: InvokeOptions): Output<GetAllowListResult>
    def get_allow_list(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAllowListResult
def get_allow_list_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAllowListResult]
    func LookupAllowList(ctx *Context, args *LookupAllowListArgs, opts ...InvokeOption) (*LookupAllowListResult, error)
func LookupAllowListOutput(ctx *Context, args *LookupAllowListOutputArgs, opts ...InvokeOption) LookupAllowListResultOutput

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

    public static class GetAllowList 
{
    public static Task<GetAllowListResult> InvokeAsync(GetAllowListArgs args, InvokeOptions? opts = null)
    public static Output<GetAllowListResult> Invoke(GetAllowListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)
public static Output<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:kafka/getAllowList:getAllowList
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getAllowList Result

    The following output properties are available:

    AllowList string
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    AllowListDesc string
    Allowlist description. Maximum length: 200 characters
    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Number of rules specified in the allowlist
    AllowListName string
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    ApplyInstanceNum int
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    AssociatedInstanceNum int
    Number of instances bound to the allowlist
    AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>
    Information about the instance bound to the allowlist
    Id string
    Uniquely identifies the resource.
    AllowList string
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    AllowListDesc string
    Allowlist description. Maximum length: 200 characters
    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Number of rules specified in the allowlist
    AllowListName string
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    ApplyInstanceNum int
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    AssociatedInstanceNum int
    Number of instances bound to the allowlist
    AssociatedInstances []GetAllowListAssociatedInstance
    Information about the instance bound to the allowlist
    Id string
    Uniquely identifies the resource.
    allowList String
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    allowListDesc String
    Allowlist description. Maximum length: 200 characters
    allowListId String
    Allowlist ID
    allowListIpNum Integer
    Number of rules specified in the allowlist
    allowListName String
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    applyInstanceNum Integer
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    associatedInstanceNum Integer
    Number of instances bound to the allowlist
    associatedInstances List<GetAllowListAssociatedInstance>
    Information about the instance bound to the allowlist
    id String
    Uniquely identifies the resource.
    allowList string
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    allowListDesc string
    Allowlist description. Maximum length: 200 characters
    allowListId string
    Allowlist ID
    allowListIpNum number
    Number of rules specified in the allowlist
    allowListName string
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    applyInstanceNum number
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    associatedInstanceNum number
    Number of instances bound to the allowlist
    associatedInstances GetAllowListAssociatedInstance[]
    Information about the instance bound to the allowlist
    id string
    Uniquely identifies the resource.
    allow_list str
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    allow_list_desc str
    Allowlist description. Maximum length: 200 characters
    allow_list_id str
    Allowlist ID
    allow_list_ip_num int
    Number of rules specified in the allowlist
    allow_list_name str
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    apply_instance_num int
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    associated_instance_num int
    Number of instances bound to the allowlist
    associated_instances Sequence[GetAllowListAssociatedInstance]
    Information about the instance bound to the allowlist
    id str
    Uniquely identifies the resource.
    allowList String
    Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges
    allowListDesc String
    Allowlist description. Maximum length: 200 characters
    allowListId String
    Allowlist ID
    allowListIpNum Number
    Number of rules specified in the allowlist
    allowListName String
    Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region
    applyInstanceNum Number
    Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails
    associatedInstanceNum Number
    Number of instances bound to the allowlist
    associatedInstances List<Property Map>
    Information about the instance bound to the allowlist
    id String
    Uniquely identifies the resource.

    Supporting Types

    GetAllowListAssociatedInstance

    InstanceId string
    ID of the instance bound to the allowlist
    InstanceName string
    Name of the instance bound to the allowlist
    InstanceId string
    ID of the instance bound to the allowlist
    InstanceName string
    Name of the instance bound to the allowlist
    instanceId String
    ID of the instance bound to the allowlist
    instanceName String
    Name of the instance bound to the allowlist
    instanceId string
    ID of the instance bound to the allowlist
    instanceName string
    Name of the instance bound to the allowlist
    instance_id str
    ID of the instance bound to the allowlist
    instance_name str
    Name of the instance bound to the allowlist
    instanceId String
    ID of the instance bound to the allowlist
    instanceName String
    Name of the instance bound to the allowlist

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.23
    published on Thursday, Apr 16, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.