1. Packages
  2. Dome9 Provider
  3. API Docs
  4. Iplist
dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

dome9.Iplist

Explore with Pulumi AI

dome9 logo
dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

    This resource is used to create and manage IP lists in Dome9. IP lists are groups of IP addresses (typically in customer cloud environments), on which common actions are applied. For example, a Security Group could be applied to a list, instead of applying it to each IP address in the list individually.

    Example Usage

    Basic usage:

    import * as pulumi from "@pulumi/pulumi";
    import * as dome9 from "@pulumi/dome9";
    
    const iplist = new dome9.Iplist("iplist", {
        description: "DESCRIPTION",
        items: [
            {
                comment: "COMMENT1",
                ip: "1.1.1.1",
            },
            {
                comment: "COMMENT2",
                ip: "2.2.2.2",
            },
        ],
    });
    
    import pulumi
    import pulumi_dome9 as dome9
    
    iplist = dome9.Iplist("iplist",
        description="DESCRIPTION",
        items=[
            {
                "comment": "COMMENT1",
                "ip": "1.1.1.1",
            },
            {
                "comment": "COMMENT2",
                "ip": "2.2.2.2",
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/dome9/dome9"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dome9.NewIplist(ctx, "iplist", &dome9.IplistArgs{
    			Description: pulumi.String("DESCRIPTION"),
    			Items: dome9.IplistItemArray{
    				&dome9.IplistItemArgs{
    					Comment: pulumi.String("COMMENT1"),
    					Ip:      pulumi.String("1.1.1.1"),
    				},
    				&dome9.IplistItemArgs{
    					Comment: pulumi.String("COMMENT2"),
    					Ip:      pulumi.String("2.2.2.2"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Dome9 = Pulumi.Dome9;
    
    return await Deployment.RunAsync(() => 
    {
        var iplist = new Dome9.Iplist("iplist", new()
        {
            Description = "DESCRIPTION",
            Items = new[]
            {
                new Dome9.Inputs.IplistItemArgs
                {
                    Comment = "COMMENT1",
                    Ip = "1.1.1.1",
                },
                new Dome9.Inputs.IplistItemArgs
                {
                    Comment = "COMMENT2",
                    Ip = "2.2.2.2",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dome9.Iplist;
    import com.pulumi.dome9.IplistArgs;
    import com.pulumi.dome9.inputs.IplistItemArgs;
    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 iplist = new Iplist("iplist", IplistArgs.builder()
                .description("DESCRIPTION")
                .items(            
                    IplistItemArgs.builder()
                        .comment("COMMENT1")
                        .ip("1.1.1.1")
                        .build(),
                    IplistItemArgs.builder()
                        .comment("COMMENT2")
                        .ip("2.2.2.2")
                        .build())
                .build());
    
        }
    }
    
    resources:
      iplist:
        type: dome9:Iplist
        properties:
          description: DESCRIPTION
          items:
            - comment: COMMENT1
              ip: 1.1.1.1
            - comment: COMMENT2
              ip: 2.2.2.2
    

    Create Iplist Resource

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

    Constructor syntax

    new Iplist(name: string, args?: IplistArgs, opts?: CustomResourceOptions);
    @overload
    def Iplist(resource_name: str,
               args: Optional[IplistArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Iplist(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               iplist_id: Optional[str] = None,
               items: Optional[Sequence[IplistItemArgs]] = None,
               name: Optional[str] = None)
    func NewIplist(ctx *Context, name string, args *IplistArgs, opts ...ResourceOption) (*Iplist, error)
    public Iplist(string name, IplistArgs? args = null, CustomResourceOptions? opts = null)
    public Iplist(String name, IplistArgs args)
    public Iplist(String name, IplistArgs args, CustomResourceOptions options)
    
    type: dome9:Iplist
    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 IplistArgs
    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 IplistArgs
    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 IplistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IplistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IplistArgs
    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 iplistResource = new Dome9.Iplist("iplistResource", new()
    {
        Description = "string",
        IplistId = "string",
        Items = new[]
        {
            new Dome9.Inputs.IplistItemArgs
            {
                Comment = "string",
                Ip = "string",
            },
        },
        Name = "string",
    });
    
    example, err := dome9.NewIplist(ctx, "iplistResource", &dome9.IplistArgs{
    	Description: pulumi.String("string"),
    	IplistId:    pulumi.String("string"),
    	Items: dome9.IplistItemArray{
    		&dome9.IplistItemArgs{
    			Comment: pulumi.String("string"),
    			Ip:      pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var iplistResource = new Iplist("iplistResource", IplistArgs.builder()
        .description("string")
        .iplistId("string")
        .items(IplistItemArgs.builder()
            .comment("string")
            .ip("string")
            .build())
        .name("string")
        .build());
    
    iplist_resource = dome9.Iplist("iplistResource",
        description="string",
        iplist_id="string",
        items=[{
            "comment": "string",
            "ip": "string",
        }],
        name="string")
    
    const iplistResource = new dome9.Iplist("iplistResource", {
        description: "string",
        iplistId: "string",
        items: [{
            comment: "string",
            ip: "string",
        }],
        name: "string",
    });
    
    type: dome9:Iplist
    properties:
        description: string
        iplistId: string
        items:
            - comment: string
              ip: string
        name: string
    

    Iplist 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 Iplist resource accepts the following input properties:

    Description string
    A description of the list (what it represents); defaults to empty string
    IplistId string
    IP list Id
    Items List<IplistItem>
    the individual IP addresses for the list; defaults to empty list
    Name string
    The name of the IP list in Dome9
    Description string
    A description of the list (what it represents); defaults to empty string
    IplistId string
    IP list Id
    Items []IplistItemArgs
    the individual IP addresses for the list; defaults to empty list
    Name string
    The name of the IP list in Dome9
    description String
    A description of the list (what it represents); defaults to empty string
    iplistId String
    IP list Id
    items List<IplistItem>
    the individual IP addresses for the list; defaults to empty list
    name String
    The name of the IP list in Dome9
    description string
    A description of the list (what it represents); defaults to empty string
    iplistId string
    IP list Id
    items IplistItem[]
    the individual IP addresses for the list; defaults to empty list
    name string
    The name of the IP list in Dome9
    description str
    A description of the list (what it represents); defaults to empty string
    iplist_id str
    IP list Id
    items Sequence[IplistItemArgs]
    the individual IP addresses for the list; defaults to empty list
    name str
    The name of the IP list in Dome9
    description String
    A description of the list (what it represents); defaults to empty string
    iplistId String
    IP list Id
    items List<Property Map>
    the individual IP addresses for the list; defaults to empty list
    name String
    The name of the IP list in Dome9

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Iplist Resource

    Get an existing Iplist 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?: IplistState, opts?: CustomResourceOptions): Iplist
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            iplist_id: Optional[str] = None,
            items: Optional[Sequence[IplistItemArgs]] = None,
            name: Optional[str] = None) -> Iplist
    func GetIplist(ctx *Context, name string, id IDInput, state *IplistState, opts ...ResourceOption) (*Iplist, error)
    public static Iplist Get(string name, Input<string> id, IplistState? state, CustomResourceOptions? opts = null)
    public static Iplist get(String name, Output<String> id, IplistState state, CustomResourceOptions options)
    resources:  _:    type: dome9:Iplist    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:
    Description string
    A description of the list (what it represents); defaults to empty string
    IplistId string
    IP list Id
    Items List<IplistItem>
    the individual IP addresses for the list; defaults to empty list
    Name string
    The name of the IP list in Dome9
    Description string
    A description of the list (what it represents); defaults to empty string
    IplistId string
    IP list Id
    Items []IplistItemArgs
    the individual IP addresses for the list; defaults to empty list
    Name string
    The name of the IP list in Dome9
    description String
    A description of the list (what it represents); defaults to empty string
    iplistId String
    IP list Id
    items List<IplistItem>
    the individual IP addresses for the list; defaults to empty list
    name String
    The name of the IP list in Dome9
    description string
    A description of the list (what it represents); defaults to empty string
    iplistId string
    IP list Id
    items IplistItem[]
    the individual IP addresses for the list; defaults to empty list
    name string
    The name of the IP list in Dome9
    description str
    A description of the list (what it represents); defaults to empty string
    iplist_id str
    IP list Id
    items Sequence[IplistItemArgs]
    the individual IP addresses for the list; defaults to empty list
    name str
    The name of the IP list in Dome9
    description String
    A description of the list (what it represents); defaults to empty string
    iplistId String
    IP list Id
    items List<Property Map>
    the individual IP addresses for the list; defaults to empty list
    name String
    The name of the IP list in Dome9

    Supporting Types

    IplistItem, IplistItemArgs

    Comment string
    Comment
    Ip string
    IP address
    Comment string
    Comment
    Ip string
    IP address
    comment String
    Comment
    ip String
    IP address
    comment string
    Comment
    ip string
    IP address
    comment str
    Comment
    ip str
    IP address
    comment String
    Comment
    ip String
    IP address

    Import

    IP list can be imported; use <IP LIST ID> as the import ID.

    For example:

    $ pulumi import dome9:index/iplist:Iplist test 00000
    

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

    Package Details

    Repository
    dome9 dome9/terraform-provider-dome9
    License
    Notes
    This Pulumi package is based on the dome9 Terraform Provider.
    dome9 logo
    dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9