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

bytepluscc.mongodb.getAllowList

bytepluscc logo
Viewing docs for bytepluscc v0.0.20
published on Thursday, Mar 26, 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
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    AllowListDesc string
    白名单的备注信息，长度不可超过 200 个字符。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowLists List<string>
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    AssociatedInstanceNum int
    已绑定当前白名单的实例总数。
    AssociatedInstances List<Byteplus.GetAllowListAssociatedInstance>
    已绑定当前白名单的实例信息。
    Id string
    Uniquely identifies the resource.
    ProjectName string
    当前白名单所属的项目。
    AllowListCategory string
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    AllowListDesc string
    白名单的备注信息，长度不可超过 200 个字符。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowLists []string
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    AssociatedInstanceNum int
    已绑定当前白名单的实例总数。
    AssociatedInstances []GetAllowListAssociatedInstance
    已绑定当前白名单的实例信息。
    Id string
    Uniquely identifies the resource.
    ProjectName string
    当前白名单所属的项目。
    allowListCategory String
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    allowListDesc String
    白名单的备注信息，长度不可超过 200 个字符。
    allowListId String
    白名单 ID。
    allowListIpNum Integer
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    associatedInstanceNum Integer
    已绑定当前白名单的实例总数。
    associatedInstances List<GetAllowListAssociatedInstance>
    已绑定当前白名单的实例信息。
    id String
    Uniquely identifies the resource.
    projectName String
    当前白名单所属的项目。
    allowListCategory string
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    allowListDesc string
    白名单的备注信息，长度不可超过 200 个字符。
    allowListId string
    白名单 ID。
    allowListIpNum number
    白名单内的 IP 地址（或地址段）总数。
    allowListName string
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    allowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists string[]
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    associatedInstanceNum number
    已绑定当前白名单的实例总数。
    associatedInstances GetAllowListAssociatedInstance[]
    已绑定当前白名单的实例信息。
    id string
    Uniquely identifies the resource.
    projectName string
    当前白名单所属的项目。
    allow_list_category str
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    allow_list_desc str
    白名单的备注信息，长度不可超过 200 个字符。
    allow_list_id str
    白名单 ID。
    allow_list_ip_num int
    白名单内的 IP 地址（或地址段）总数。
    allow_list_name str
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    allow_list_type str
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allow_lists Sequence[str]
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    associated_instance_num int
    已绑定当前白名单的实例总数。
    associated_instances Sequence[GetAllowListAssociatedInstance]
    已绑定当前白名单的实例信息。
    id str
    Uniquely identifies the resource.
    project_name str
    当前白名单所属的项目。
    allowListCategory String
    白名单类型。取值范围如下：Ordinary：普通白名单；Default：默认白名单。
    allowListDesc String
    白名单的备注信息，长度不可超过 200 个字符。
    allowListId String
    白名单 ID。
    allowListIpNum Number
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    输入 IP 地址或 CIDR 格式的 IP 地址段。
    associatedInstanceNum Number
    已绑定当前白名单的实例总数。
    associatedInstances List<Property Map>
    已绑定当前白名单的实例信息。
    id String
    Uniquely identifies the resource.
    projectName String
    当前白名单所属的项目。

    Supporting Types

    GetAllowListAssociatedInstance

    InstanceId string
    已绑定当前白名单的实例 ID。
    InstanceName string
    已绑定当前白名单的实例名称。
    ProjectName string
    实例所属的项目名称。
    Vpc string
    实例所属的私有网络 ID。
    InstanceId string
    已绑定当前白名单的实例 ID。
    InstanceName string
    已绑定当前白名单的实例名称。
    ProjectName string
    实例所属的项目名称。
    Vpc string
    实例所属的私有网络 ID。
    instanceId String
    已绑定当前白名单的实例 ID。
    instanceName String
    已绑定当前白名单的实例名称。
    projectName String
    实例所属的项目名称。
    vpc String
    实例所属的私有网络 ID。
    instanceId string
    已绑定当前白名单的实例 ID。
    instanceName string
    已绑定当前白名单的实例名称。
    projectName string
    实例所属的项目名称。
    vpc string
    实例所属的私有网络 ID。
    instance_id str
    已绑定当前白名单的实例 ID。
    instance_name str
    已绑定当前白名单的实例名称。
    project_name str
    实例所属的项目名称。
    vpc str
    实例所属的私有网络 ID。
    instanceId String
    已绑定当前白名单的实例 ID。
    instanceName String
    已绑定当前白名单的实例名称。
    projectName String
    实例所属的项目名称。
    vpc String
    实例所属的私有网络 ID。

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