1. Packages
  2. Volcengine
  3. API Docs
  4. mongodb
  5. getMongoAllowLists
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine.mongodb.getMongoAllowLists

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooMongoAllowList = new volcengine.mongodb.MongoAllowList("fooMongoAllowList", {
        allowListName: "acc-test",
        allowListDesc: "acc-test",
        allowListType: "IPv4",
        allowList: "10.1.1.3,10.2.3.0/24,10.1.1.1",
    });
    const fooMongoAllowLists = volcengine.mongodb.getMongoAllowListsOutput({
        allowListIds: [fooMongoAllowList.id],
        regionId: "cn-beijing",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_mongo_allow_list = volcengine.mongodb.MongoAllowList("fooMongoAllowList",
        allow_list_name="acc-test",
        allow_list_desc="acc-test",
        allow_list_type="IPv4",
        allow_list="10.1.1.3,10.2.3.0/24,10.1.1.1")
    foo_mongo_allow_lists = volcengine.mongodb.get_mongo_allow_lists_output(allow_list_ids=[foo_mongo_allow_list.id],
        region_id="cn-beijing")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooMongoAllowList, err := mongodb.NewMongoAllowList(ctx, "fooMongoAllowList", &mongodb.MongoAllowListArgs{
    			AllowListName: pulumi.String("acc-test"),
    			AllowListDesc: pulumi.String("acc-test"),
    			AllowListType: pulumi.String("IPv4"),
    			AllowList:     pulumi.String("10.1.1.3,10.2.3.0/24,10.1.1.1"),
    		})
    		if err != nil {
    			return err
    		}
    		_ = mongodb.GetMongoAllowListsOutput(ctx, mongodb.GetMongoAllowListsOutputArgs{
    			AllowListIds: pulumi.StringArray{
    				fooMongoAllowList.ID(),
    			},
    			RegionId: pulumi.String("cn-beijing"),
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooMongoAllowList = new Volcengine.Mongodb.MongoAllowList("fooMongoAllowList", new()
        {
            AllowListName = "acc-test",
            AllowListDesc = "acc-test",
            AllowListType = "IPv4",
            AllowList = "10.1.1.3,10.2.3.0/24,10.1.1.1",
        });
    
        var fooMongoAllowLists = Volcengine.Mongodb.GetMongoAllowLists.Invoke(new()
        {
            AllowListIds = new[]
            {
                fooMongoAllowList.Id,
            },
            RegionId = "cn-beijing",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.mongodb.MongoAllowList;
    import com.pulumi.volcengine.mongodb.MongoAllowListArgs;
    import com.pulumi.volcengine.mongodb.MongodbFunctions;
    import com.pulumi.volcengine.mongodb.inputs.GetMongoAllowListsArgs;
    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) {
            var fooMongoAllowList = new MongoAllowList("fooMongoAllowList", MongoAllowListArgs.builder()        
                .allowListName("acc-test")
                .allowListDesc("acc-test")
                .allowListType("IPv4")
                .allowList("10.1.1.3,10.2.3.0/24,10.1.1.1")
                .build());
    
            final var fooMongoAllowLists = MongodbFunctions.getMongoAllowLists(GetMongoAllowListsArgs.builder()
                .allowListIds(fooMongoAllowList.id())
                .regionId("cn-beijing")
                .build());
    
        }
    }
    
    resources:
      fooMongoAllowList:
        type: volcengine:mongodb:MongoAllowList
        properties:
          allowListName: acc-test
          allowListDesc: acc-test
          allowListType: IPv4
          allowList: 10.1.1.3,10.2.3.0/24,10.1.1.1
    variables:
      fooMongoAllowLists:
        fn::invoke:
          Function: volcengine:mongodb:getMongoAllowLists
          Arguments:
            allowListIds:
              - ${fooMongoAllowList.id}
            regionId: cn-beijing
    

    Using getMongoAllowLists

    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 getMongoAllowLists(args: GetMongoAllowListsArgs, opts?: InvokeOptions): Promise<GetMongoAllowListsResult>
    function getMongoAllowListsOutput(args: GetMongoAllowListsOutputArgs, opts?: InvokeOptions): Output<GetMongoAllowListsResult>
    def get_mongo_allow_lists(allow_list_ids: Optional[Sequence[str]] = None,
                              instance_id: Optional[str] = None,
                              output_file: Optional[str] = None,
                              project_name: Optional[str] = None,
                              region_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMongoAllowListsResult
    def get_mongo_allow_lists_output(allow_list_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              instance_id: Optional[pulumi.Input[str]] = None,
                              output_file: Optional[pulumi.Input[str]] = None,
                              project_name: Optional[pulumi.Input[str]] = None,
                              region_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetMongoAllowListsResult]
    func GetMongoAllowLists(ctx *Context, args *GetMongoAllowListsArgs, opts ...InvokeOption) (*GetMongoAllowListsResult, error)
    func GetMongoAllowListsOutput(ctx *Context, args *GetMongoAllowListsOutputArgs, opts ...InvokeOption) GetMongoAllowListsResultOutput

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

    public static class GetMongoAllowLists 
    {
        public static Task<GetMongoAllowListsResult> InvokeAsync(GetMongoAllowListsArgs args, InvokeOptions? opts = null)
        public static Output<GetMongoAllowListsResult> Invoke(GetMongoAllowListsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMongoAllowListsResult> getMongoAllowLists(GetMongoAllowListsArgs args, InvokeOptions options)
    public static Output<GetMongoAllowListsResult> getMongoAllowLists(GetMongoAllowListsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:mongodb/getMongoAllowLists:getMongoAllowLists
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RegionId string
    The region ID.
    AllowListIds List<string>
    The allow list IDs to query.
    InstanceId string
    The instance ID to query.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the allow list.
    RegionId string
    The region ID.
    AllowListIds []string
    The allow list IDs to query.
    InstanceId string
    The instance ID to query.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the allow list.
    regionId String
    The region ID.
    allowListIds List<String>
    The allow list IDs to query.
    instanceId String
    The instance ID to query.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the allow list.
    regionId string
    The region ID.
    allowListIds string[]
    The allow list IDs to query.
    instanceId string
    The instance ID to query.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of the allow list.
    region_id str
    The region ID.
    allow_list_ids Sequence[str]
    The allow list IDs to query.
    instance_id str
    The instance ID to query.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of the allow list.
    regionId String
    The region ID.
    allowListIds List<String>
    The allow list IDs to query.
    instanceId String
    The instance ID to query.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the allow list.

    getMongoAllowLists Result

    The following output properties are available:

    AllowLists List<GetMongoAllowListsAllowList>
    The collection of mongodb allow list query.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    TotalCount int
    The total count of mongodb allow lists query.
    AllowListIds List<string>
    InstanceId string
    The instance id that bound to the allow list.
    OutputFile string
    ProjectName string
    The project name of the allow list.
    AllowLists []GetMongoAllowListsAllowList
    The collection of mongodb allow list query.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    TotalCount int
    The total count of mongodb allow lists query.
    AllowListIds []string
    InstanceId string
    The instance id that bound to the allow list.
    OutputFile string
    ProjectName string
    The project name of the allow list.
    allowLists List<GetMongoAllowListsAllowList>
    The collection of mongodb allow list query.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    totalCount Integer
    The total count of mongodb allow lists query.
    allowListIds List<String>
    instanceId String
    The instance id that bound to the allow list.
    outputFile String
    projectName String
    The project name of the allow list.
    allowLists GetMongoAllowListsAllowList[]
    The collection of mongodb allow list query.
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    totalCount number
    The total count of mongodb allow lists query.
    allowListIds string[]
    instanceId string
    The instance id that bound to the allow list.
    outputFile string
    projectName string
    The project name of the allow list.
    allow_lists Sequence[GetMongoAllowListsAllowList]
    The collection of mongodb allow list query.
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    total_count int
    The total count of mongodb allow lists query.
    allow_list_ids Sequence[str]
    instance_id str
    The instance id that bound to the allow list.
    output_file str
    project_name str
    The project name of the allow list.
    allowLists List<Property Map>
    The collection of mongodb allow list query.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    totalCount Number
    The total count of mongodb allow lists query.
    allowListIds List<String>
    instanceId String
    The instance id that bound to the allow list.
    outputFile String
    projectName String
    The project name of the allow list.

    Supporting Types

    GetMongoAllowListsAllowList

    AllowList string
    The list of IP address in allow list.
    AllowListDesc string
    The description of allow list.
    AllowListId string
    The ID of allow list.
    AllowListIpNum int
    The number of allow list IPs.
    AllowListName string
    The allow list name.
    AllowListType string
    The IP address type in allow list.
    AssociatedInstanceNum int
    The total number of instances bound under the allow list.
    AssociatedInstances List<GetMongoAllowListsAllowListAssociatedInstance>
    The list of associated instances.
    ProjectName string
    The project name of the allow list.
    AllowList string
    The list of IP address in allow list.
    AllowListDesc string
    The description of allow list.
    AllowListId string
    The ID of allow list.
    AllowListIpNum int
    The number of allow list IPs.
    AllowListName string
    The allow list name.
    AllowListType string
    The IP address type in allow list.
    AssociatedInstanceNum int
    The total number of instances bound under the allow list.
    AssociatedInstances []GetMongoAllowListsAllowListAssociatedInstance
    The list of associated instances.
    ProjectName string
    The project name of the allow list.
    allowList String
    The list of IP address in allow list.
    allowListDesc String
    The description of allow list.
    allowListId String
    The ID of allow list.
    allowListIpNum Integer
    The number of allow list IPs.
    allowListName String
    The allow list name.
    allowListType String
    The IP address type in allow list.
    associatedInstanceNum Integer
    The total number of instances bound under the allow list.
    associatedInstances List<GetMongoAllowListsAllowListAssociatedInstance>
    The list of associated instances.
    projectName String
    The project name of the allow list.
    allowList string
    The list of IP address in allow list.
    allowListDesc string
    The description of allow list.
    allowListId string
    The ID of allow list.
    allowListIpNum number
    The number of allow list IPs.
    allowListName string
    The allow list name.
    allowListType string
    The IP address type in allow list.
    associatedInstanceNum number
    The total number of instances bound under the allow list.
    associatedInstances GetMongoAllowListsAllowListAssociatedInstance[]
    The list of associated instances.
    projectName string
    The project name of the allow list.
    allow_list str
    The list of IP address in allow list.
    allow_list_desc str
    The description of allow list.
    allow_list_id str
    The ID of allow list.
    allow_list_ip_num int
    The number of allow list IPs.
    allow_list_name str
    The allow list name.
    allow_list_type str
    The IP address type in allow list.
    associated_instance_num int
    The total number of instances bound under the allow list.
    associated_instances Sequence[GetMongoAllowListsAllowListAssociatedInstance]
    The list of associated instances.
    project_name str
    The project name of the allow list.
    allowList String
    The list of IP address in allow list.
    allowListDesc String
    The description of allow list.
    allowListId String
    The ID of allow list.
    allowListIpNum Number
    The number of allow list IPs.
    allowListName String
    The allow list name.
    allowListType String
    The IP address type in allow list.
    associatedInstanceNum Number
    The total number of instances bound under the allow list.
    associatedInstances List<Property Map>
    The list of associated instances.
    projectName String
    The project name of the allow list.

    GetMongoAllowListsAllowListAssociatedInstance

    InstanceId string
    The instance ID to query.
    InstanceName string
    The instance name that bound to the allow list.
    ProjectName string
    The project name of the allow list.
    Vpc string
    The VPC ID.
    InstanceId string
    The instance ID to query.
    InstanceName string
    The instance name that bound to the allow list.
    ProjectName string
    The project name of the allow list.
    Vpc string
    The VPC ID.
    instanceId String
    The instance ID to query.
    instanceName String
    The instance name that bound to the allow list.
    projectName String
    The project name of the allow list.
    vpc String
    The VPC ID.
    instanceId string
    The instance ID to query.
    instanceName string
    The instance name that bound to the allow list.
    projectName string
    The project name of the allow list.
    vpc string
    The VPC ID.
    instance_id str
    The instance ID to query.
    instance_name str
    The instance name that bound to the allow list.
    project_name str
    The project name of the allow list.
    vpc str
    The VPC ID.
    instanceId String
    The instance ID to query.
    instanceName String
    The instance name that bound to the allow list.
    projectName String
    The project name of the allow list.
    vpc String
    The VPC ID.

    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.31 published on Monday, May 12, 2025 by Volcengine