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

ibm.CisCustomList

Explore with Pulumi AI

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

    Provides an IBM Cloud Internet Services custom list resource to create, update, and delete the custom list of an instance. For more information, see Using custom lists.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const customList = new ibm.CisCustomList("customList", {
        cisId: ibm_cis.instance.id,
        kind: _var.list.kind,
        description: _var.list.description,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    custom_list = ibm.CisCustomList("customList",
        cis_id=ibm_cis["instance"]["id"],
        kind=var["list"]["kind"],
        description=var["list"]["description"])
    
    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.NewCisCustomList(ctx, "customList", &ibm.CisCustomListArgs{
    			CisId:       pulumi.Any(ibm_cis.Instance.Id),
    			Kind:        pulumi.Any(_var.List.Kind),
    			Description: pulumi.Any(_var.List.Description),
    		})
    		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 customList = new Ibm.CisCustomList("customList", new()
        {
            CisId = ibm_cis.Instance.Id,
            Kind = @var.List.Kind,
            Description = @var.List.Description,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.CisCustomList;
    import com.pulumi.ibm.CisCustomListArgs;
    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 customList = new CisCustomList("customList", CisCustomListArgs.builder()
                .cisId(ibm_cis.instance().id())
                .kind(var_.list().kind())
                .description(var_.list().description())
                .build());
    
        }
    }
    
    resources:
      customList:
        type: ibm:CisCustomList
        properties:
          cisId: ${ibm_cis.instance.id}
          kind: ${var.list.kind}
          description: ${var.list.description}
    

    Create CisCustomList Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CisCustomList(name: string, args: CisCustomListArgs, opts?: CustomResourceOptions);
    @overload
    def CisCustomList(resource_name: str,
                      args: CisCustomListArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def CisCustomList(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cis_id: Optional[str] = None,
                      kind: Optional[str] = None,
                      cis_custom_list_id: Optional[str] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None)
    func NewCisCustomList(ctx *Context, name string, args CisCustomListArgs, opts ...ResourceOption) (*CisCustomList, error)
    public CisCustomList(string name, CisCustomListArgs args, CustomResourceOptions? opts = null)
    public CisCustomList(String name, CisCustomListArgs args)
    public CisCustomList(String name, CisCustomListArgs args, CustomResourceOptions options)
    
    type: ibm:CisCustomList
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CisCustomListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CisCustomListArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CisCustomListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisCustomListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisCustomListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var cisCustomListResource = new Ibm.CisCustomList("cisCustomListResource", new()
    {
        CisId = "string",
        Kind = "string",
        CisCustomListId = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := ibm.NewCisCustomList(ctx, "cisCustomListResource", &ibm.CisCustomListArgs{
    	CisId:           pulumi.String("string"),
    	Kind:            pulumi.String("string"),
    	CisCustomListId: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Name:            pulumi.String("string"),
    })
    
    var cisCustomListResource = new CisCustomList("cisCustomListResource", CisCustomListArgs.builder()
        .cisId("string")
        .kind("string")
        .cisCustomListId("string")
        .description("string")
        .name("string")
        .build());
    
    cis_custom_list_resource = ibm.CisCustomList("cisCustomListResource",
        cis_id="string",
        kind="string",
        cis_custom_list_id="string",
        description="string",
        name="string")
    
    const cisCustomListResource = new ibm.CisCustomList("cisCustomListResource", {
        cisId: "string",
        kind: "string",
        cisCustomListId: "string",
        description: "string",
        name: "string",
    });
    
    type: ibm:CisCustomList
    properties:
        cisCustomListId: string
        cisId: string
        description: string
        kind: string
        name: string
    

    CisCustomList Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CisCustomList resource accepts the following input properties:

    CisId string
    The ID of the CIS service instance.
    Kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    CisCustomListId string
    Description string
    Description of the custom list.
    Name string
    Name of the custom list. Use this name in filter and rule expressions.
    CisId string
    The ID of the CIS service instance.
    Kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    CisCustomListId string
    Description string
    Description of the custom list.
    Name string
    Name of the custom list. Use this name in filter and rule expressions.
    cisId String
    The ID of the CIS service instance.
    kind String
    The kind of the custom list. Allowed values are ip, asn, hostname.
    cisCustomListId String
    description String
    Description of the custom list.
    name String
    Name of the custom list. Use this name in filter and rule expressions.
    cisId string
    The ID of the CIS service instance.
    kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    cisCustomListId string
    description string
    Description of the custom list.
    name string
    Name of the custom list. Use this name in filter and rule expressions.
    cis_id str
    The ID of the CIS service instance.
    kind str
    The kind of the custom list. Allowed values are ip, asn, hostname.
    cis_custom_list_id str
    description str
    Description of the custom list.
    name str
    Name of the custom list. Use this name in filter and rule expressions.
    cisId String
    The ID of the CIS service instance.
    kind String
    The kind of the custom list. Allowed values are ip, asn, hostname.
    cisCustomListId String
    description String
    Description of the custom list.
    name String
    Name of the custom list. Use this name in filter and rule expressions.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CisCustomList resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListId string
    (String) ID of the custom list.
    NumItems double
    (int) The number of items in the custom list.
    NumReferencingFilters double
    (int) The number of filters referencing the custom list.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListId string
    (String) ID of the custom list.
    NumItems float64
    (int) The number of items in the custom list.
    NumReferencingFilters float64
    (int) The number of filters referencing the custom list.
    id String
    The provider-assigned unique ID for this managed resource.
    listId String
    (String) ID of the custom list.
    numItems Double
    (int) The number of items in the custom list.
    numReferencingFilters Double
    (int) The number of filters referencing the custom list.
    id string
    The provider-assigned unique ID for this managed resource.
    listId string
    (String) ID of the custom list.
    numItems number
    (int) The number of items in the custom list.
    numReferencingFilters number
    (int) The number of filters referencing the custom list.
    id str
    The provider-assigned unique ID for this managed resource.
    list_id str
    (String) ID of the custom list.
    num_items float
    (int) The number of items in the custom list.
    num_referencing_filters float
    (int) The number of filters referencing the custom list.
    id String
    The provider-assigned unique ID for this managed resource.
    listId String
    (String) ID of the custom list.
    numItems Number
    (int) The number of items in the custom list.
    numReferencingFilters Number
    (int) The number of filters referencing the custom list.

    Look up Existing CisCustomList Resource

    Get an existing CisCustomList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CisCustomListState, opts?: CustomResourceOptions): CisCustomList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cis_custom_list_id: Optional[str] = None,
            cis_id: Optional[str] = None,
            description: Optional[str] = None,
            kind: Optional[str] = None,
            list_id: Optional[str] = None,
            name: Optional[str] = None,
            num_items: Optional[float] = None,
            num_referencing_filters: Optional[float] = None) -> CisCustomList
    func GetCisCustomList(ctx *Context, name string, id IDInput, state *CisCustomListState, opts ...ResourceOption) (*CisCustomList, error)
    public static CisCustomList Get(string name, Input<string> id, CisCustomListState? state, CustomResourceOptions? opts = null)
    public static CisCustomList get(String name, Output<String> id, CisCustomListState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisCustomList    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CisCustomListId string
    CisId string
    The ID of the CIS service instance.
    Description string
    Description of the custom list.
    Kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    ListId string
    (String) ID of the custom list.
    Name string
    Name of the custom list. Use this name in filter and rule expressions.
    NumItems double
    (int) The number of items in the custom list.
    NumReferencingFilters double
    (int) The number of filters referencing the custom list.
    CisCustomListId string
    CisId string
    The ID of the CIS service instance.
    Description string
    Description of the custom list.
    Kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    ListId string
    (String) ID of the custom list.
    Name string
    Name of the custom list. Use this name in filter and rule expressions.
    NumItems float64
    (int) The number of items in the custom list.
    NumReferencingFilters float64
    (int) The number of filters referencing the custom list.
    cisCustomListId String
    cisId String
    The ID of the CIS service instance.
    description String
    Description of the custom list.
    kind String
    The kind of the custom list. Allowed values are ip, asn, hostname.
    listId String
    (String) ID of the custom list.
    name String
    Name of the custom list. Use this name in filter and rule expressions.
    numItems Double
    (int) The number of items in the custom list.
    numReferencingFilters Double
    (int) The number of filters referencing the custom list.
    cisCustomListId string
    cisId string
    The ID of the CIS service instance.
    description string
    Description of the custom list.
    kind string
    The kind of the custom list. Allowed values are ip, asn, hostname.
    listId string
    (String) ID of the custom list.
    name string
    Name of the custom list. Use this name in filter and rule expressions.
    numItems number
    (int) The number of items in the custom list.
    numReferencingFilters number
    (int) The number of filters referencing the custom list.
    cis_custom_list_id str
    cis_id str
    The ID of the CIS service instance.
    description str
    Description of the custom list.
    kind str
    The kind of the custom list. Allowed values are ip, asn, hostname.
    list_id str
    (String) ID of the custom list.
    name str
    Name of the custom list. Use this name in filter and rule expressions.
    num_items float
    (int) The number of items in the custom list.
    num_referencing_filters float
    (int) The number of filters referencing the custom list.
    cisCustomListId String
    cisId String
    The ID of the CIS service instance.
    description String
    Description of the custom list.
    kind String
    The kind of the custom list. Allowed values are ip, asn, hostname.
    listId String
    (String) ID of the custom list.
    name String
    Name of the custom list. Use this name in filter and rule expressions.
    numItems Number
    (int) The number of items in the custom list.
    numReferencingFilters Number
    (int) The number of filters referencing the custom list.

    Import

    Example

    terraform

    $ pulumi import ibm:index/cisCustomList:CisCustomList custom_list 77bc00aa67184d0b8b7233b131c432cf:crn:v1:staging:public:internet-svcs-ci:global:a/01652b251c3ae2787110a995d8db0135:1a9174b6-0106-417a-844b-c8eb43a72f63::
    

    To learn more about importing existing cloud resources, see Importing resources.

    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