1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCisCustomLists
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud

ibm.getCisCustomLists

Explore with Pulumi AI

ibm logo
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud

    Retrieve information about IBM Cloud Internet Services custom list data sources. For more information, see Using custom lists.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const customLists = ibm.getCisCustomLists({
        cisId: ibm_cis.instance.id,
        listId: ibm_cis.lists.list_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    custom_lists = ibm.get_cis_custom_lists(cis_id=ibm_cis["instance"]["id"],
        list_id=ibm_cis["lists"]["list_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetCisCustomLists(ctx, &ibm.GetCisCustomListsArgs{
    			CisId:  ibm_cis.Instance.Id,
    			ListId: pulumi.StringRef(ibm_cis.Lists.List_id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var customLists = Ibm.GetCisCustomLists.Invoke(new()
        {
            CisId = ibm_cis.Instance.Id,
            ListId = ibm_cis.Lists.List_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetCisCustomListsArgs;
    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 customLists = IbmFunctions.getCisCustomLists(GetCisCustomListsArgs.builder()
                .cisId(ibm_cis.instance().id())
                .listId(ibm_cis.lists().list_id())
                .build());
    
        }
    }
    
    variables:
      customLists:
        fn::invoke:
          function: ibm:getCisCustomLists
          arguments:
            cisId: ${ibm_cis.instance.id}
            listId: ${ibm_cis.lists.list_id}
    

    Attributes reference

    In addition to the argument reference list, you can access the following attribute references after your data source is created.

    • lists - (List)
      • list_id - (string) The unique ID of the list.
      • description - (string) Description of the custom list.
      • kind - (string) The kind of the custom list.
      • name - (string) Name of the custom list.
      • num_items - (int) The number of items in the list.
      • num_referencing_filters - (int) The number of filters referencing the list.

    Using getCisCustomLists

    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 getCisCustomLists(args: GetCisCustomListsArgs, opts?: InvokeOptions): Promise<GetCisCustomListsResult>
    function getCisCustomListsOutput(args: GetCisCustomListsOutputArgs, opts?: InvokeOptions): Output<GetCisCustomListsResult>
    def get_cis_custom_lists(cis_id: Optional[str] = None,
                             id: Optional[str] = None,
                             list_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCisCustomListsResult
    def get_cis_custom_lists_output(cis_id: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             list_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCisCustomListsResult]
    func GetCisCustomLists(ctx *Context, args *GetCisCustomListsArgs, opts ...InvokeOption) (*GetCisCustomListsResult, error)
    func GetCisCustomListsOutput(ctx *Context, args *GetCisCustomListsOutputArgs, opts ...InvokeOption) GetCisCustomListsResultOutput

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

    public static class GetCisCustomLists 
    {
        public static Task<GetCisCustomListsResult> InvokeAsync(GetCisCustomListsArgs args, InvokeOptions? opts = null)
        public static Output<GetCisCustomListsResult> Invoke(GetCisCustomListsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCisCustomListsResult> getCisCustomLists(GetCisCustomListsArgs args, InvokeOptions options)
    public static Output<GetCisCustomListsResult> getCisCustomLists(GetCisCustomListsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCisCustomLists:getCisCustomLists
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CisId string
    The ID of the CIS service instance.
    Id string
    ListId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    CisId string
    The ID of the CIS service instance.
    Id string
    ListId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    cisId String
    The ID of the CIS service instance.
    id String
    listId String
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    cisId string
    The ID of the CIS service instance.
    id string
    listId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    cis_id str
    The ID of the CIS service instance.
    id str
    list_id str
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    cisId String
    The ID of the CIS service instance.
    id String
    listId String
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.

    getCisCustomLists Result

    The following output properties are available:

    Supporting Types

    GetCisCustomListsList

    Description string
    Kind string
    ListId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    Name string
    NumItems double
    NumReferencingFilters double
    Description string
    Kind string
    ListId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    Name string
    NumItems float64
    NumReferencingFilters float64
    description String
    kind String
    listId String
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    name String
    numItems Double
    numReferencingFilters Double
    description string
    kind string
    listId string
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    name string
    numItems number
    numReferencingFilters number
    description str
    kind str
    list_id str
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    name str
    num_items float
    num_referencing_filters float
    description String
    kind String
    listId String
    The ID of the custom list. If list_id is provided, details are given for this particular list; otherwise, you get the details of all the lists.
    name String
    numItems Number
    numReferencingFilters Number

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud