1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rocketmq
  5. AllowList
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.AllowList

volcenginecc logo
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    RocketMQ访问白名单。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const rocketMQAllowListDemo = new volcenginecc.rocketmq.AllowList("RocketMQAllowListDemo", {
    allowListType: "IPv4",
    allowList: "192.xxx.0.0/24",
    allowListName: "ccapi-test",
    allowListDesc: "this is a description",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

rocket_mq_allow_list_demo = volcenginecc.rocketmq.AllowList("RocketMQAllowListDemo",
    allow_list_type="IPv4",
    allow_list="192.xxx.0.0/24",
    allow_list_name="ccapi-test",
    allow_list_desc="this is a description")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rocketmq"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.NewAllowList(ctx, "RocketMQAllowListDemo", &rocketmq.AllowListArgs{
			AllowListType: pulumi.String("IPv4"),
			AllowList:     pulumi.String("192.xxx.0.0/24"),
			AllowListName: pulumi.String("ccapi-test"),
			AllowListDesc: pulumi.String("this is a description"),
		})
		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 rocketMQAllowListDemo = new Volcenginecc.Rocketmq.AllowList("RocketMQAllowListDemo", new()
    {
        AllowListType = "IPv4",
        AllowListValue = "192.xxx.0.0/24",
        AllowListName = "ccapi-test",
        AllowListDesc = "this is a description",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.rocketmq.AllowList;
import com.volcengine.volcenginecc.rocketmq.AllowListArgs;
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 rocketMQAllowListDemo = new AllowList("rocketMQAllowListDemo", AllowListArgs.builder()
            .allowListType("IPv4")
            .allowList("192.xxx.0.0/24")
            .allowListName("ccapi-test")
            .allowListDesc("this is a description")
            .build());

    }
}

    resources:
  rocketMQAllowListDemo:
    type: volcenginecc:rocketmq:AllowList
    name: RocketMQAllowListDemo
    properties:
      allowListType: IPv4
      allowList: 192.xxx.0.0/24
      allowListName: ccapi-test
      allowListDesc: this is a description

    Create AllowList Resource

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

    Constructor syntax

    new AllowList(name: string, args: AllowListArgs, opts?: CustomResourceOptions);
    @overload
def AllowList(resource_name: str,
              args: AllowListArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def AllowList(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              allow_list_name: Optional[str] = None,
              allow_list: Optional[str] = None,
              allow_list_category: Optional[str] = None,
              allow_list_desc: Optional[str] = None,
              allow_list_type: Optional[str] = None,
              apply_db_instance_num: Optional[int] = None,
              associated_instances: Optional[Sequence[AllowListAssociatedInstanceArgs]] = None,
              instance_id: Optional[str] = None)
    func NewAllowList(ctx *Context, name string, args AllowListArgs, opts ...ResourceOption) (*AllowList, error)
    public AllowList(string name, AllowListArgs args, CustomResourceOptions? opts = null)
    public AllowList(String name, AllowListArgs args)
public AllowList(String name, AllowListArgs args, CustomResourceOptions options)

    type: volcenginecc:rocketmq:AllowList
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 AllowListArgs
    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 AllowListArgs
    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 AllowListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AllowListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AllowListArgs
    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 exampleallowListResourceResourceFromRocketmqallowList = new Volcenginecc.Rocketmq.AllowList("exampleallowListResourceResourceFromRocketmqallowList", new()
{
    AllowListName = "string",
    AllowListValue = "string",
    AllowListCategory = "string",
    AllowListDesc = "string",
    AllowListType = "string",
    ApplyDbInstanceNum = 0,
    AssociatedInstances = new[]
    {
        new Volcenginecc.Rocketmq.Inputs.AllowListAssociatedInstanceArgs
        {
            InstanceId = "string",
        },
    },
    InstanceId = "string",
});

    example, err := rocketmq.NewAllowList(ctx, "exampleallowListResourceResourceFromRocketmqallowList", &rocketmq.AllowListArgs{
	AllowListName:      pulumi.String("string"),
	AllowList:          pulumi.String("string"),
	AllowListCategory:  pulumi.String("string"),
	AllowListDesc:      pulumi.String("string"),
	AllowListType:      pulumi.String("string"),
	ApplyDbInstanceNum: pulumi.Int(0),
	AssociatedInstances: rocketmq.AllowListAssociatedInstanceArray{
		&rocketmq.AllowListAssociatedInstanceArgs{
			InstanceId: pulumi.String("string"),
		},
	},
	InstanceId: pulumi.String("string"),
})

    var exampleallowListResourceResourceFromRocketmqallowList = new com.volcengine.volcenginecc.rocketmq.AllowList("exampleallowListResourceResourceFromRocketmqallowList", com.volcengine.volcenginecc.rocketmq.AllowListArgs.builder()
    .allowListName("string")
    .allowList("string")
    .allowListCategory("string")
    .allowListDesc("string")
    .allowListType("string")
    .applyDbInstanceNum(0)
    .associatedInstances(AllowListAssociatedInstanceArgs.builder()
        .instanceId("string")
        .build())
    .instanceId("string")
    .build());

    exampleallow_list_resource_resource_from_rocketmqallow_list = volcenginecc.rocketmq.AllowList("exampleallowListResourceResourceFromRocketmqallowList",
    allow_list_name="string",
    allow_list="string",
    allow_list_category="string",
    allow_list_desc="string",
    allow_list_type="string",
    apply_db_instance_num=0,
    associated_instances=[{
        "instance_id": "string",
    }],
    instance_id="string")

    const exampleallowListResourceResourceFromRocketmqallowList = new volcenginecc.rocketmq.AllowList("exampleallowListResourceResourceFromRocketmqallowList", {
    allowListName: "string",
    allowList: "string",
    allowListCategory: "string",
    allowListDesc: "string",
    allowListType: "string",
    applyDbInstanceNum: 0,
    associatedInstances: [{
        instanceId: "string",
    }],
    instanceId: "string",
});

    type: volcenginecc:rocketmq:AllowList
properties:
    allowList: string
    allowListCategory: string
    allowListDesc: string
    allowListName: string
    allowListType: string
    applyDbInstanceNum: 0
    associatedInstances:
        - instanceId: string
    instanceId: string

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

    AllowListName string
    白名单名称。
    AllowListCategory string
    白名单分类。
    AllowListDesc string
    白名单描述。
    AllowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    AllowListValue string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    ApplyDbInstanceNum int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    AssociatedInstances List<Volcengine.AllowListAssociatedInstance>
    InstanceId string
    实例ID。
    AllowListName string
    白名单名称。
    AllowList string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    AllowListCategory string
    白名单分类。
    AllowListDesc string
    白名单描述。
    AllowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    ApplyDbInstanceNum int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    AssociatedInstances []AllowListAssociatedInstanceArgs
    InstanceId string
    实例ID。
    allowListName String
    白名单名称。
    allowList String
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory String
    白名单分类。
    allowListDesc String
    白名单描述。
    allowListType String
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum Integer
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstances List<AllowListAssociatedInstance>
    instanceId String
    实例ID。
    allowListName string
    白名单名称。
    allowList string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory string
    白名单分类。
    allowListDesc string
    白名单描述。
    allowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum number
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstances AllowListAssociatedInstance[]
    instanceId string
    实例ID。
    allow_list_name str
    白名单名称。
    allow_list str
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allow_list_category str
    白名单分类。
    allow_list_desc str
    白名单描述。
    allow_list_type str
    白名单内的IP地址类型，当前仅支持IPv4。
    apply_db_instance_num int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    instance_id str
    实例ID。
    allowListName String
    白名单名称。
    allowList String
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory String
    白名单分类。
    allowListDesc String
    白名单描述。
    allowListType String
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum Number
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstances List<Property Map>
    instanceId String
    实例ID。

    Outputs

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

    AllowListId string
    白名单的id。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AssociatedInstanceNum int
    白名单下绑定的实例总数
    Id string
    The provider-assigned unique ID for this managed resource.
    AllowListId string
    白名单的id。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AssociatedInstanceNum int
    白名单下绑定的实例总数
    Id string
    The provider-assigned unique ID for this managed resource.
    allowListId String
    白名单的id。
    allowListIpNum Integer
    白名单内的 IP 地址（或地址段）总数。
    associatedInstanceNum Integer
    白名单下绑定的实例总数
    id String
    The provider-assigned unique ID for this managed resource.
    allowListId string
    白名单的id。
    allowListIpNum number
    白名单内的 IP 地址（或地址段）总数。
    associatedInstanceNum number
    白名单下绑定的实例总数
    id string
    The provider-assigned unique ID for this managed resource.
    allow_list_id str
    白名单的id。
    allow_list_ip_num int
    白名单内的 IP 地址（或地址段）总数。
    associated_instance_num int
    白名单下绑定的实例总数
    id str
    The provider-assigned unique ID for this managed resource.
    allowListId String
    白名单的id。
    allowListIpNum Number
    白名单内的 IP 地址（或地址段）总数。
    associatedInstanceNum Number
    白名单下绑定的实例总数
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AllowList Resource

    Get an existing AllowList 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?: AllowListState, opts?: CustomResourceOptions): AllowList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list: Optional[str] = None,
        allow_list_category: Optional[str] = None,
        allow_list_desc: Optional[str] = None,
        allow_list_id: Optional[str] = None,
        allow_list_ip_num: Optional[int] = None,
        allow_list_name: Optional[str] = None,
        allow_list_type: Optional[str] = None,
        apply_db_instance_num: Optional[int] = None,
        associated_instance_num: Optional[int] = None,
        associated_instances: Optional[Sequence[AllowListAssociatedInstanceArgs]] = None,
        instance_id: Optional[str] = None) -> AllowList
    func GetAllowList(ctx *Context, name string, id IDInput, state *AllowListState, opts ...ResourceOption) (*AllowList, error)
    public static AllowList Get(string name, Input<string> id, AllowListState? state, CustomResourceOptions? opts = null)
    public static AllowList get(String name, Output<String> id, AllowListState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rocketmq:AllowList    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:
    AllowListCategory string
    白名单分类。
    AllowListDesc string
    白名单描述。
    AllowListId string
    白名单的id。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    AllowListValue string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    ApplyDbInstanceNum int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    AssociatedInstanceNum int
    白名单下绑定的实例总数
    AssociatedInstances List<Volcengine.AllowListAssociatedInstance>
    InstanceId string
    实例ID。
    AllowList string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    AllowListCategory string
    白名单分类。
    AllowListDesc string
    白名单描述。
    AllowListId string
    白名单的id。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    ApplyDbInstanceNum int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    AssociatedInstanceNum int
    白名单下绑定的实例总数
    AssociatedInstances []AllowListAssociatedInstanceArgs
    InstanceId string
    实例ID。
    allowList String
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory String
    白名单分类。
    allowListDesc String
    白名单描述。
    allowListId String
    白名单的id。
    allowListIpNum Integer
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum Integer
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstanceNum Integer
    白名单下绑定的实例总数
    associatedInstances List<AllowListAssociatedInstance>
    instanceId String
    实例ID。
    allowList string
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory string
    白名单分类。
    allowListDesc string
    白名单描述。
    allowListId string
    白名单的id。
    allowListIpNum number
    白名单内的 IP 地址（或地址段）总数。
    allowListName string
    白名单名称。
    allowListType string
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum number
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstanceNum number
    白名单下绑定的实例总数
    associatedInstances AllowListAssociatedInstance[]
    instanceId string
    实例ID。
    allow_list str
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allow_list_category str
    白名单分类。
    allow_list_desc str
    白名单描述。
    allow_list_id str
    白名单的id。
    allow_list_ip_num int
    白名单内的 IP 地址（或地址段）总数。
    allow_list_name str
    白名单名称。
    allow_list_type str
    白名单内的IP地址类型，当前仅支持IPv4。
    apply_db_instance_num int
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associated_instance_num int
    白名单下绑定的实例总数
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    instance_id str
    实例ID。
    allowList String
    IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
    allowListCategory String
    白名单分类。
    allowListDesc String
    白名单描述。
    allowListId String
    白名单的id。
    allowListIpNum Number
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的IP地址类型，当前仅支持IPv4。
    applyDbInstanceNum Number
    已应用实例数量，即当前该白名单所绑定的实例数。主要目的是确认本次修改的影响范围，避免误操作引发故障。
    associatedInstanceNum Number
    白名单下绑定的实例总数
    associatedInstances List<Property Map>
    instanceId String
    实例ID。

    Supporting Types

    AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

    InstanceId string
    实例ID。
    InstanceId string
    实例ID。
    instanceId String
    实例ID。
    instanceId string
    实例ID。
    instance_id str
    实例ID。
    instanceId String
    实例ID。

    Import

    $ pulumi import volcenginecc:rocketmq/allowList:AllowList example "allow_list_id"

    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.24
    published on Monday, Mar 9, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.