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

bytepluscc.mongodb.getAllowList

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

    Data Source schema for Byteplus::MongoDB::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:mongodb/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:

    AllowListCategory string
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    AllowListDesc string
    Allowlist remarks. Maximum length: 200 characters.
    AllowListId string
    Allowlist ID.
    AllowListIpNum int
    Total number of IP addresses (or address ranges) in the allowlist.
    AllowListName string
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    AllowListType string
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    AllowLists List<string>
    Enter an IP address or a CIDR-format IP address range.
    AssociatedInstanceNum int
    Total number of instances bound to the current allowlist.
    AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>
    Instance information bound to the current allowlist.
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project to which the current allowlist belongs.
    AllowListCategory string
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    AllowListDesc string
    Allowlist remarks. Maximum length: 200 characters.
    AllowListId string
    Allowlist ID.
    AllowListIpNum int
    Total number of IP addresses (or address ranges) in the allowlist.
    AllowListName string
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    AllowListType string
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    AllowLists []string
    Enter an IP address or a CIDR-format IP address range.
    AssociatedInstanceNum int
    Total number of instances bound to the current allowlist.
    AssociatedInstances []GetAllowListAssociatedInstance
    Instance information bound to the current allowlist.
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project to which the current allowlist belongs.
    allowListCategory String
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    allowListDesc String
    Allowlist remarks. Maximum length: 200 characters.
    allowListId String
    Allowlist ID.
    allowListIpNum Integer
    Total number of IP addresses (or address ranges) in the allowlist.
    allowListName String
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    allowListType String
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    allowLists List<String>
    Enter an IP address or a CIDR-format IP address range.
    associatedInstanceNum Integer
    Total number of instances bound to the current allowlist.
    associatedInstances List<GetAllowListAssociatedInstance>
    Instance information bound to the current allowlist.
    id String
    Uniquely identifies the resource.
    projectName String
    Project to which the current allowlist belongs.
    allowListCategory string
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    allowListDesc string
    Allowlist remarks. Maximum length: 200 characters.
    allowListId string
    Allowlist ID.
    allowListIpNum number
    Total number of IP addresses (or address ranges) in the allowlist.
    allowListName string
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    allowListType string
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    allowLists string[]
    Enter an IP address or a CIDR-format IP address range.
    associatedInstanceNum number
    Total number of instances bound to the current allowlist.
    associatedInstances GetAllowListAssociatedInstance[]
    Instance information bound to the current allowlist.
    id string
    Uniquely identifies the resource.
    projectName string
    Project to which the current allowlist belongs.
    allow_list_category str
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    allow_list_desc str
    Allowlist remarks. Maximum length: 200 characters.
    allow_list_id str
    Allowlist ID.
    allow_list_ip_num int
    Total number of IP addresses (or address ranges) in the allowlist.
    allow_list_name str
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    allow_list_type str
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    allow_lists Sequence[str]
    Enter an IP address or a CIDR-format IP address range.
    associated_instance_num int
    Total number of instances bound to the current allowlist.
    associated_instances Sequence[GetAllowListAssociatedInstance]
    Instance information bound to the current allowlist.
    id str
    Uniquely identifies the resource.
    project_name str
    Project to which the current allowlist belongs.
    allowListCategory String
    Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.
    allowListDesc String
    Allowlist remarks. Maximum length: 200 characters.
    allowListId String
    Allowlist ID.
    allowListIpNum Number
    Total number of IP addresses (or address ranges) in the allowlist.
    allowListName String
    Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.
    allowListType String
    IP address type in the allowlist. Only IPv4 addresses are currently supported.
    allowLists List<String>
    Enter an IP address or a CIDR-format IP address range.
    associatedInstanceNum Number
    Total number of instances bound to the current allowlist.
    associatedInstances List<Property Map>
    Instance information bound to the current allowlist.
    id String
    Uniquely identifies the resource.
    projectName String
    Project to which the current allowlist belongs.

    Supporting Types

    GetAllowListAssociatedInstance

    InstanceId string
    Instance ID bound to the current allowlist.
    InstanceName string
    Instance name bound to the current allowlist.
    ProjectName string
    Project name of the instance.
    Vpc string
    Private network ID of the instance.
    InstanceId string
    Instance ID bound to the current allowlist.
    InstanceName string
    Instance name bound to the current allowlist.
    ProjectName string
    Project name of the instance.
    Vpc string
    Private network ID of the instance.
    instanceId String
    Instance ID bound to the current allowlist.
    instanceName String
    Instance name bound to the current allowlist.
    projectName String
    Project name of the instance.
    vpc String
    Private network ID of the instance.
    instanceId string
    Instance ID bound to the current allowlist.
    instanceName string
    Instance name bound to the current allowlist.
    projectName string
    Project name of the instance.
    vpc string
    Private network ID of the instance.
    instance_id str
    Instance ID bound to the current allowlist.
    instance_name str
    Instance name bound to the current allowlist.
    project_name str
    Project name of the instance.
    vpc str
    Private network ID of the instance.
    instanceId String
    Instance ID bound to the current allowlist.
    instanceName String
    Instance name bound to the current allowlist.
    projectName String
    Project name of the instance.
    vpc String
    Private network ID of the instance.

    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.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.