1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. escloud
  6. IpAllowList
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine

    IP allowlist information

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const example = new volcenginecc.escloud.IpAllowList("Example", {
        instanceId: "o-008wv7krnmw4",
        type: "PRIVATE_ES",
        allowLists: [
            "10.0.0.0/16",
            "192.168.1.1",
        ],
        groups: [
            {
                name: "group1",
                allow_list: [
                    "10.0.0.0/16",
                    "192.168.1.2",
                ],
            },
            {
                name: "group2",
                allow_list: [
                    "192.168.2.1",
                    "127.0.0.1",
                ],
            },
        ],
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    example = volcenginecc.escloud.IpAllowList("Example",
        instance_id="o-008wv7krnmw4",
        type="PRIVATE_ES",
        allow_lists=[
            "10.0.0.0/16",
            "192.168.1.1",
        ],
        groups=[
            {
                "name": "group1",
                "allow_list": [
                    "10.0.0.0/16",
                    "192.168.1.2",
                ],
            },
            {
                "name": "group2",
                "allow_list": [
                    "192.168.2.1",
                    "127.0.0.1",
                ],
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/escloud"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := escloud.NewIpAllowList(ctx, "Example", &escloud.IpAllowListArgs{
    			InstanceId: pulumi.String("o-008wv7krnmw4"),
    			Type:       pulumi.String("PRIVATE_ES"),
    			AllowLists: pulumi.StringArray{
    				pulumi.String("10.0.0.0/16"),
    				pulumi.String("192.168.1.1"),
    			},
    			Groups: escloud.IpAllowListGroupArray{
    				&escloud.IpAllowListGroupArgs{
    					Name: pulumi.String("group1"),
    					Allow_list: []string{
    						"10.0.0.0/16",
    						"192.168.1.2",
    					},
    				},
    				&escloud.IpAllowListGroupArgs{
    					Name: pulumi.String("group2"),
    					Allow_list: []string{
    						"192.168.2.1",
    						"127.0.0.1",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Volcenginecc.Escloud.IpAllowList("Example", new()
        {
            InstanceId = "o-008wv7krnmw4",
            Type = "PRIVATE_ES",
            AllowLists = new[]
            {
                "10.0.0.0/16",
                "192.168.1.1",
            },
            Groups = new[]
            {
                new Volcenginecc.Escloud.Inputs.IpAllowListGroupArgs
                {
                    Name = "group1",
                    Allow_list = new[]
                    {
                        "10.0.0.0/16",
                        "192.168.1.2",
                    },
                },
                new Volcenginecc.Escloud.Inputs.IpAllowListGroupArgs
                {
                    Name = "group2",
                    Allow_list = new[]
                    {
                        "192.168.2.1",
                        "127.0.0.1",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.escloud.IpAllowList;
    import com.volcengine.volcenginecc.escloud.IpAllowListArgs;
    import com.pulumi.volcenginecc.escloud.inputs.IpAllowListGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new IpAllowList("example", IpAllowListArgs.builder()
                .instanceId("o-008wv7krnmw4")
                .type("PRIVATE_ES")
                .allowLists(            
                    "10.0.0.0/16",
                    "192.168.1.1")
                .groups(            
                    IpAllowListGroupArgs.builder()
                        .name("group1")
                        .allow_list(Arrays.asList(                    
                            "10.0.0.0/16",
                            "192.168.1.2"))
                        .build(),
                    IpAllowListGroupArgs.builder()
                        .name("group2")
                        .allow_list(Arrays.asList(                    
                            "192.168.2.1",
                            "127.0.0.1"))
                        .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: volcenginecc:escloud:IpAllowList
        name: Example
        properties:
          instanceId: o-008wv7krnmw4
          type: PRIVATE_ES
          allowLists:
            - 10.0.0.0/16
            - 192.168.1.1
          groups:
            - name: group1
              allow_list:
                - 10.0.0.0/16
                - 192.168.1.2
            - name: group2
              allow_list:
                - 192.168.2.1
                - 127.0.0.1
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_escloud_ipallowlist" "Example" {
      instance_id = "o-008wv7krnmw4"
      type        = "PRIVATE_ES"
      allow_lists = ["10.0.0.0/16", "192.168.1.1"]
      groups {
        name       = "group1"
        allow_list = ["10.0.0.0/16", "192.168.1.2"]
      }
      groups {
        name       = "group2"
        allow_list = ["192.168.2.1", "127.0.0.1"]
      }
    }
    

    Create IpAllowList Resource

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

    Constructor syntax

    new IpAllowList(name: string, args: IpAllowListArgs, opts?: CustomResourceOptions);
    @overload
    def IpAllowList(resource_name: str,
                    args: IpAllowListArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def IpAllowList(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    allow_lists: Optional[Sequence[str]] = None,
                    groups: Optional[Sequence[IpAllowListGroupArgs]] = None,
                    instance_id: Optional[str] = None,
                    type: Optional[str] = None)
    func NewIpAllowList(ctx *Context, name string, args IpAllowListArgs, opts ...ResourceOption) (*IpAllowList, error)
    public IpAllowList(string name, IpAllowListArgs args, CustomResourceOptions? opts = null)
    public IpAllowList(String name, IpAllowListArgs args)
    public IpAllowList(String name, IpAllowListArgs args, CustomResourceOptions options)
    
    type: volcenginecc:escloud:IpAllowList
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_escloud_ip_allow_list" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IpAllowListArgs
    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 IpAllowListArgs
    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 IpAllowListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpAllowListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpAllowListArgs
    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 ipAllowListResource = new Volcenginecc.Escloud.IpAllowList("ipAllowListResource", new()
    {
        AllowLists = new[]
        {
            "string",
        },
        Groups = new[]
        {
            new Volcenginecc.Escloud.Inputs.IpAllowListGroupArgs
            {
                AllowLists = new[]
                {
                    "string",
                },
                Name = "string",
            },
        },
        InstanceId = "string",
        Type = "string",
    });
    
    example, err := escloud.NewIpAllowList(ctx, "ipAllowListResource", &escloud.IpAllowListArgs{
    	AllowLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Groups: escloud.IpAllowListGroupArray{
    		&escloud.IpAllowListGroupArgs{
    			AllowLists: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Name: pulumi.String("string"),
    		},
    	},
    	InstanceId: pulumi.String("string"),
    	Type:       pulumi.String("string"),
    })
    
    resource "volcenginecc_escloud_ip_allow_list" "ipAllowListResource" {
      lifecycle {
        create_before_destroy = true
      }
      allow_lists = ["string"]
      groups {
        allow_lists = ["string"]
        name        = "string"
      }
      instance_id = "string"
      type        = "string"
    }
    
    var ipAllowListResource = new IpAllowList("ipAllowListResource", IpAllowListArgs.builder()
        .allowLists("string")
        .groups(IpAllowListGroupArgs.builder()
            .allowLists("string")
            .name("string")
            .build())
        .instanceId("string")
        .type("string")
        .build());
    
    ip_allow_list_resource = volcenginecc.escloud.IpAllowList("ipAllowListResource",
        allow_lists=["string"],
        groups=[{
            "allow_lists": ["string"],
            "name": "string",
        }],
        instance_id="string",
        type="string")
    
    const ipAllowListResource = new volcenginecc.escloud.IpAllowList("ipAllowListResource", {
        allowLists: ["string"],
        groups: [{
            allowLists: ["string"],
            name: "string",
        }],
        instanceId: "string",
        type: "string",
    });
    
    type: volcenginecc:escloud:IpAllowList
    properties:
        allowLists:
            - string
        groups:
            - allowLists:
                - string
              name: string
        instanceId: string
        type: string
    

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

    AllowLists List<string>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    Groups List<Volcengine.IpAllowListGroup>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceId string
    Instance ID
    Type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    AllowLists []string
    Default group IP allowlist list; separate multiple IPs with commas (,)
    Groups []IpAllowListGroupArgs
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceId string
    Instance ID
    Type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allow_lists list(string)
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups list(object)
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_id string
    Instance ID
    type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists List<String>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups List<IpAllowListGroup>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId String
    Instance ID
    type String
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists string[]
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups IpAllowListGroup[]
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId string
    Instance ID
    type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allow_lists Sequence[str]
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups Sequence[IpAllowListGroupArgs]
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_id str
    Instance ID
    type str
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists List<String>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups List<Property Map>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId String
    Instance ID
    type String
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpAllowList 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 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 IpAllowList Resource

    Get an existing IpAllowList 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?: IpAllowListState, opts?: CustomResourceOptions): IpAllowList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_lists: Optional[Sequence[str]] = None,
            groups: Optional[Sequence[IpAllowListGroupArgs]] = None,
            instance_id: Optional[str] = None,
            type: Optional[str] = None) -> IpAllowList
    func GetIpAllowList(ctx *Context, name string, id IDInput, state *IpAllowListState, opts ...ResourceOption) (*IpAllowList, error)
    public static IpAllowList Get(string name, Input<string> id, IpAllowListState? state, CustomResourceOptions? opts = null)
    public static IpAllowList get(String name, Output<String> id, IpAllowListState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:escloud:IpAllowList    get:      id: ${id}
    import {
      to = volcenginecc_escloud_ip_allow_list.example
      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:
    AllowLists List<string>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    Groups List<Volcengine.IpAllowListGroup>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceId string
    Instance ID
    Type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    AllowLists []string
    Default group IP allowlist list; separate multiple IPs with commas (,)
    Groups []IpAllowListGroupArgs
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceId string
    Instance ID
    Type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allow_lists list(string)
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups list(object)
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_id string
    Instance ID
    type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists List<String>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups List<IpAllowListGroup>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId String
    Instance ID
    type String
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists string[]
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups IpAllowListGroup[]
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId string
    Instance ID
    type string
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allow_lists Sequence[str]
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups Sequence[IpAllowListGroupArgs]
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_id str
    Instance ID
    type str
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access
    allowLists List<String>
    Default group IP allowlist list; separate multiple IPs with commas (,)
    groups List<Property Map>
    Custom group IP allowlist Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceId String
    Instance ID
    type String
    Network type

    - PRIVATE_ES: Instance private network access
    - PRIVATE_KIBANA: Kibana private network access
    - PUBLIC_ES: Instance public network access
    - PUBLIC_KIBANA: Kibana public network access

    Supporting Types

    IpAllowListGroup, IpAllowListGroupArgs

    AllowLists List<string>
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    Name string
    Custom group name
    AllowLists []string
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    Name string
    Custom group name
    allow_lists list(string)
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    name string
    Custom group name
    allowLists List<String>
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    name String
    Custom group name
    allowLists string[]
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    name string
    Custom group name
    allow_lists Sequence[str]
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    name str
    Custom group name
    allowLists List<String>
    Custom group IP allowlist list cannot be empty; to configure multiple IPs, use commas (,)
    name String
    Custom group name

    Import

    $ pulumi import volcenginecc:escloud/ipAllowList:IpAllowList example "instance_id|type"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.50
    published on Monday, Jul 20, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial