1. Packages
  2. Volcengine
  3. API Docs
  4. iam
  5. AllowedIpAddress
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine

    Provides a resource to manage iam allowed ip address

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.iam.AllowedIpAddress("foo", {
        enableIpList: true,
        ipLists: [
            {
                description: "test1",
                ip: "your ip",
            },
            {
                description: "test2",
                ip: "your ip",
            },
        ],
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.iam.AllowedIpAddress("foo",
        enable_ip_list=True,
        ip_lists=[
            volcengine.iam.AllowedIpAddressIpListArgs(
                description="test1",
                ip="your ip",
            ),
            volcengine.iam.AllowedIpAddressIpListArgs(
                description="test2",
                ip="your ip",
            ),
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iam.NewAllowedIpAddress(ctx, "foo", &iam.AllowedIpAddressArgs{
    			EnableIpList: pulumi.Bool(true),
    			IpLists: iam.AllowedIpAddressIpListArray{
    				&iam.AllowedIpAddressIpListArgs{
    					Description: pulumi.String("test1"),
    					Ip:          pulumi.String("your ip"),
    				},
    				&iam.AllowedIpAddressIpListArgs{
    					Description: pulumi.String("test2"),
    					Ip:          pulumi.String("your ip"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Iam.AllowedIpAddress("foo", new()
        {
            EnableIpList = true,
            IpLists = new[]
            {
                new Volcengine.Iam.Inputs.AllowedIpAddressIpListArgs
                {
                    Description = "test1",
                    Ip = "your ip",
                },
                new Volcengine.Iam.Inputs.AllowedIpAddressIpListArgs
                {
                    Description = "test2",
                    Ip = "your ip",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.iam.AllowedIpAddress;
    import com.pulumi.volcengine.iam.AllowedIpAddressArgs;
    import com.pulumi.volcengine.iam.inputs.AllowedIpAddressIpListArgs;
    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 foo = new AllowedIpAddress("foo", AllowedIpAddressArgs.builder()        
                .enableIpList(true)
                .ipLists(            
                    AllowedIpAddressIpListArgs.builder()
                        .description("test1")
                        .ip("your ip")
                        .build(),
                    AllowedIpAddressIpListArgs.builder()
                        .description("test2")
                        .ip("your ip")
                        .build())
                .build());
    
        }
    }
    
    resources:
      foo:
        type: volcengine:iam:AllowedIpAddress
        properties:
          enableIpList: true
          ipLists:
            - description: test1
              ip: your ip
            - description: test2
              ip: your ip
    

    Create AllowedIpAddress Resource

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

    Constructor syntax

    new AllowedIpAddress(name: string, args: AllowedIpAddressArgs, opts?: CustomResourceOptions);
    @overload
    def AllowedIpAddress(resource_name: str,
                         args: AllowedIpAddressArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AllowedIpAddress(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         enable_ip_list: Optional[bool] = None,
                         ip_lists: Optional[Sequence[AllowedIpAddressIpListArgs]] = None)
    func NewAllowedIpAddress(ctx *Context, name string, args AllowedIpAddressArgs, opts ...ResourceOption) (*AllowedIpAddress, error)
    public AllowedIpAddress(string name, AllowedIpAddressArgs args, CustomResourceOptions? opts = null)
    public AllowedIpAddress(String name, AllowedIpAddressArgs args)
    public AllowedIpAddress(String name, AllowedIpAddressArgs args, CustomResourceOptions options)
    
    type: volcengine:iam:AllowedIpAddress
    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 AllowedIpAddressArgs
    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 AllowedIpAddressArgs
    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 AllowedIpAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AllowedIpAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AllowedIpAddressArgs
    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 allowedIpAddressResource = new Volcengine.Iam.AllowedIpAddress("allowedIpAddressResource", new()
    {
        EnableIpList = false,
        IpLists = new[]
        {
            new Volcengine.Iam.Inputs.AllowedIpAddressIpListArgs
            {
                Ip = "string",
                Description = "string",
            },
        },
    });
    
    example, err := iam.NewAllowedIpAddress(ctx, "allowedIpAddressResource", &iam.AllowedIpAddressArgs{
    	EnableIpList: pulumi.Bool(false),
    	IpLists: iam.AllowedIpAddressIpListArray{
    		&iam.AllowedIpAddressIpListArgs{
    			Ip:          pulumi.String("string"),
    			Description: pulumi.String("string"),
    		},
    	},
    })
    
    var allowedIpAddressResource = new AllowedIpAddress("allowedIpAddressResource", AllowedIpAddressArgs.builder()
        .enableIpList(false)
        .ipLists(AllowedIpAddressIpListArgs.builder()
            .ip("string")
            .description("string")
            .build())
        .build());
    
    allowed_ip_address_resource = volcengine.iam.AllowedIpAddress("allowedIpAddressResource",
        enable_ip_list=False,
        ip_lists=[{
            "ip": "string",
            "description": "string",
        }])
    
    const allowedIpAddressResource = new volcengine.iam.AllowedIpAddress("allowedIpAddressResource", {
        enableIpList: false,
        ipLists: [{
            ip: "string",
            description: "string",
        }],
    });
    
    type: volcengine:iam:AllowedIpAddress
    properties:
        enableIpList: false
        ipLists:
            - description: string
              ip: string
    

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

    EnableIpList bool
    Whether to enable the IP whitelist.
    IpLists List<AllowedIpAddressIpList>
    The IP whitelist list.
    EnableIpList bool
    Whether to enable the IP whitelist.
    IpLists []AllowedIpAddressIpListArgs
    The IP whitelist list.
    enableIpList Boolean
    Whether to enable the IP whitelist.
    ipLists List<AllowedIpAddressIpList>
    The IP whitelist list.
    enableIpList boolean
    Whether to enable the IP whitelist.
    ipLists AllowedIpAddressIpList[]
    The IP whitelist list.
    enable_ip_list bool
    Whether to enable the IP whitelist.
    ip_lists Sequence[AllowedIpAddressIpListArgs]
    The IP whitelist list.
    enableIpList Boolean
    Whether to enable the IP whitelist.
    ipLists List<Property Map>
    The IP whitelist list.

    Outputs

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

    Get an existing AllowedIpAddress 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?: AllowedIpAddressState, opts?: CustomResourceOptions): AllowedIpAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enable_ip_list: Optional[bool] = None,
            ip_lists: Optional[Sequence[AllowedIpAddressIpListArgs]] = None) -> AllowedIpAddress
    func GetAllowedIpAddress(ctx *Context, name string, id IDInput, state *AllowedIpAddressState, opts ...ResourceOption) (*AllowedIpAddress, error)
    public static AllowedIpAddress Get(string name, Input<string> id, AllowedIpAddressState? state, CustomResourceOptions? opts = null)
    public static AllowedIpAddress get(String name, Output<String> id, AllowedIpAddressState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:iam:AllowedIpAddress    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:
    EnableIpList bool
    Whether to enable the IP whitelist.
    IpLists List<AllowedIpAddressIpList>
    The IP whitelist list.
    EnableIpList bool
    Whether to enable the IP whitelist.
    IpLists []AllowedIpAddressIpListArgs
    The IP whitelist list.
    enableIpList Boolean
    Whether to enable the IP whitelist.
    ipLists List<AllowedIpAddressIpList>
    The IP whitelist list.
    enableIpList boolean
    Whether to enable the IP whitelist.
    ipLists AllowedIpAddressIpList[]
    The IP whitelist list.
    enable_ip_list bool
    Whether to enable the IP whitelist.
    ip_lists Sequence[AllowedIpAddressIpListArgs]
    The IP whitelist list.
    enableIpList Boolean
    Whether to enable the IP whitelist.
    ipLists List<Property Map>
    The IP whitelist list.

    Supporting Types

    AllowedIpAddressIpList, AllowedIpAddressIpListArgs

    Ip string
    The IP address.
    Description string
    The description of the IP address.
    Ip string
    The IP address.
    Description string
    The description of the IP address.
    ip String
    The IP address.
    description String
    The description of the IP address.
    ip string
    The IP address.
    description string
    The description of the IP address.
    ip str
    The IP address.
    description str
    The description of the IP address.
    ip String
    The IP address.
    description String
    The description of the IP address.

    Import

    Iam AllowedIpAddress key don’t support import

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

    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.45 published on Tuesday, Feb 10, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate