Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rocketmq
  5. RocketMQAllowList
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.rocketmq.RocketMQAllowList

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage rocketmq allow list

    Example Usage

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

const foo = new volcengine.rocketmq.RocketMQAllowList("foo", {
    allowLists: [
        "192.168.0.0/24",
        "192.168.2.0/24",
    ],
    allowListDesc: "acc-test",
    allowListName: "acc-test-allow-list",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rocketmq.RocketMQAllowList("foo",
    allow_lists=[
        "192.168.0.0/24",
        "192.168.2.0/24",
    ],
    allow_list_desc="acc-test",
    allow_list_name="acc-test-allow-list")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.NewRocketMQAllowList(ctx, "foo", &rocketmq.RocketMQAllowListArgs{
			AllowLists: pulumi.StringArray{
				pulumi.String("192.168.0.0/24"),
				pulumi.String("192.168.2.0/24"),
			},
			AllowListDesc: pulumi.String("acc-test"),
			AllowListName: pulumi.String("acc-test-allow-list"),
		})
		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.Rocketmq.RocketMQAllowList("foo", new()
    {
        AllowLists = new[]
        {
            "192.168.0.0/24",
            "192.168.2.0/24",
        },
        AllowListDesc = "acc-test",
        AllowListName = "acc-test-allow-list",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rocketmq.RocketMQAllowList;
import com.pulumi.volcengine.rocketmq.RocketMQAllowListArgs;
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 RocketMQAllowList("foo", RocketMQAllowListArgs.builder()        
            .allowLists(            
                "192.168.0.0/24",
                "192.168.2.0/24")
            .allowListDesc("acc-test")
            .allowListName("acc-test-allow-list")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:rocketmq:RocketMQAllowList
    properties:
      allowLists:
        - 192.168.0.0/24
        - 192.168.2.0/24
      allowListDesc: acc-test
      allowListName: acc-test-allow-list

    Create RocketMQAllowList Resource

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

    Constructor syntax

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

@overload
def RocketMQAllowList(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      allow_list_name: Optional[str] = None,
                      allow_lists: Optional[Sequence[str]] = None,
                      allow_list_desc: Optional[str] = None)
    func NewRocketMQAllowList(ctx *Context, name string, args RocketMQAllowListArgs, opts ...ResourceOption) (*RocketMQAllowList, error)
    public RocketMQAllowList(string name, RocketMQAllowListArgs args, CustomResourceOptions? opts = null)
    public RocketMQAllowList(String name, RocketMQAllowListArgs args)
public RocketMQAllowList(String name, RocketMQAllowListArgs args, CustomResourceOptions options)

    type: volcengine:rocketmq:RocketMQAllowList
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 RocketMQAllowListArgs
    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 RocketMQAllowListArgs
    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 RocketMQAllowListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RocketMQAllowListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RocketMQAllowListArgs
    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 rocketMQAllowListResource = new Volcengine.Rocketmq.RocketMQAllowList("rocketMQAllowListResource", new()
{
    AllowListName = "string",
    AllowLists = new[]
    {
        "string",
    },
    AllowListDesc = "string",
});

    example, err := rocketmq.NewRocketMQAllowList(ctx, "rocketMQAllowListResource", &rocketmq.RocketMQAllowListArgs{
	AllowListName: pulumi.String("string"),
	AllowLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowListDesc: pulumi.String("string"),
})

    var rocketMQAllowListResource = new RocketMQAllowList("rocketMQAllowListResource", RocketMQAllowListArgs.builder()
    .allowListName("string")
    .allowLists("string")
    .allowListDesc("string")
    .build());

    rocket_mq_allow_list_resource = volcengine.rocketmq.RocketMQAllowList("rocketMQAllowListResource",
    allow_list_name="string",
    allow_lists=["string"],
    allow_list_desc="string")

    const rocketMQAllowListResource = new volcengine.rocketmq.RocketMQAllowList("rocketMQAllowListResource", {
    allowListName: "string",
    allowLists: ["string"],
    allowListDesc: "string",
});

    type: volcengine:rocketmq:RocketMQAllowList
properties:
    allowListDesc: string
    allowListName: string
    allowLists:
        - string

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

    AllowListName string
    The name of the allow list.
    AllowLists List<string>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    AllowListDesc string
    The description of the allow list.
    AllowListName string
    The name of the allow list.
    AllowLists []string
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    AllowListDesc string
    The description of the allow list.
    allowListName String
    The name of the allow list.
    allowLists List<String>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    allowListDesc String
    The description of the allow list.
    allowListName string
    The name of the allow list.
    allowLists string[]
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    allowListDesc string
    The description of the allow list.
    allow_list_name str
    The name of the allow list.
    allow_lists Sequence[str]
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    allow_list_desc str
    The description of the allow list.
    allowListName String
    The name of the allow list.
    allowLists List<String>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    allowListDesc String
    The description of the allow list.

    Outputs

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

    AllowListIpNum int
    The number of ip address in the rocketmq allow list.
    AllowListType string
    The type of the rocketmq allow list.
    AssociatedInstanceNum int
    The number of the rocketmq instances associated with the allow list.
    AssociatedInstances List<RocketMQAllowListAssociatedInstance>
    The associated instance information of the allow list.
    Id string
    The provider-assigned unique ID for this managed resource.
    AllowListIpNum int
    The number of ip address in the rocketmq allow list.
    AllowListType string
    The type of the rocketmq allow list.
    AssociatedInstanceNum int
    The number of the rocketmq instances associated with the allow list.
    AssociatedInstances []RocketMQAllowListAssociatedInstance
    The associated instance information of the allow list.
    Id string
    The provider-assigned unique ID for this managed resource.
    allowListIpNum Integer
    The number of ip address in the rocketmq allow list.
    allowListType String
    The type of the rocketmq allow list.
    associatedInstanceNum Integer
    The number of the rocketmq instances associated with the allow list.
    associatedInstances List<RocketMQAllowListAssociatedInstance>
    The associated instance information of the allow list.
    id String
    The provider-assigned unique ID for this managed resource.
    allowListIpNum number
    The number of ip address in the rocketmq allow list.
    allowListType string
    The type of the rocketmq allow list.
    associatedInstanceNum number
    The number of the rocketmq instances associated with the allow list.
    associatedInstances RocketMQAllowListAssociatedInstance[]
    The associated instance information of the allow list.
    id string
    The provider-assigned unique ID for this managed resource.
    allow_list_ip_num int
    The number of ip address in the rocketmq allow list.
    allow_list_type str
    The type of the rocketmq allow list.
    associated_instance_num int
    The number of the rocketmq instances associated with the allow list.
    associated_instances Sequence[RocketMQAllowListAssociatedInstance]
    The associated instance information of the allow list.
    id str
    The provider-assigned unique ID for this managed resource.
    allowListIpNum Number
    The number of ip address in the rocketmq allow list.
    allowListType String
    The type of the rocketmq allow list.
    associatedInstanceNum Number
    The number of the rocketmq instances associated with the allow list.
    associatedInstances List<Property Map>
    The associated instance information of the allow list.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RocketMQAllowList Resource

    Get an existing RocketMQAllowList 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?: RocketMQAllowListState, opts?: CustomResourceOptions): RocketMQAllowList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list_desc: Optional[str] = None,
        allow_list_ip_num: Optional[int] = None,
        allow_list_name: Optional[str] = None,
        allow_list_type: Optional[str] = None,
        allow_lists: Optional[Sequence[str]] = None,
        associated_instance_num: Optional[int] = None,
        associated_instances: Optional[Sequence[RocketMQAllowListAssociatedInstanceArgs]] = None) -> RocketMQAllowList
    func GetRocketMQAllowList(ctx *Context, name string, id IDInput, state *RocketMQAllowListState, opts ...ResourceOption) (*RocketMQAllowList, error)
    public static RocketMQAllowList Get(string name, Input<string> id, RocketMQAllowListState? state, CustomResourceOptions? opts = null)
    public static RocketMQAllowList get(String name, Output<String> id, RocketMQAllowListState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:rocketmq:RocketMQAllowList    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:
    AllowListDesc string
    The description of the allow list.
    AllowListIpNum int
    The number of ip address in the rocketmq allow list.
    AllowListName string
    The name of the allow list.
    AllowListType string
    The type of the rocketmq allow list.
    AllowLists List<string>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    AssociatedInstanceNum int
    The number of the rocketmq instances associated with the allow list.
    AssociatedInstances List<RocketMQAllowListAssociatedInstance>
    The associated instance information of the allow list.
    AllowListDesc string
    The description of the allow list.
    AllowListIpNum int
    The number of ip address in the rocketmq allow list.
    AllowListName string
    The name of the allow list.
    AllowListType string
    The type of the rocketmq allow list.
    AllowLists []string
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    AssociatedInstanceNum int
    The number of the rocketmq instances associated with the allow list.
    AssociatedInstances []RocketMQAllowListAssociatedInstanceArgs
    The associated instance information of the allow list.
    allowListDesc String
    The description of the allow list.
    allowListIpNum Integer
    The number of ip address in the rocketmq allow list.
    allowListName String
    The name of the allow list.
    allowListType String
    The type of the rocketmq allow list.
    allowLists List<String>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    associatedInstanceNum Integer
    The number of the rocketmq instances associated with the allow list.
    associatedInstances List<RocketMQAllowListAssociatedInstance>
    The associated instance information of the allow list.
    allowListDesc string
    The description of the allow list.
    allowListIpNum number
    The number of ip address in the rocketmq allow list.
    allowListName string
    The name of the allow list.
    allowListType string
    The type of the rocketmq allow list.
    allowLists string[]
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    associatedInstanceNum number
    The number of the rocketmq instances associated with the allow list.
    associatedInstances RocketMQAllowListAssociatedInstance[]
    The associated instance information of the allow list.
    allow_list_desc str
    The description of the allow list.
    allow_list_ip_num int
    The number of ip address in the rocketmq allow list.
    allow_list_name str
    The name of the allow list.
    allow_list_type str
    The type of the rocketmq allow list.
    allow_lists Sequence[str]
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    associated_instance_num int
    The number of the rocketmq instances associated with the allow list.
    associated_instances Sequence[RocketMQAllowListAssociatedInstanceArgs]
    The associated instance information of the allow list.
    allowListDesc String
    The description of the allow list.
    allowListIpNum Number
    The number of ip address in the rocketmq allow list.
    allowListName String
    The name of the allow list.
    allowListType String
    The type of the rocketmq allow list.
    allowLists List<String>
    The list of ip addresses. Enter an IP address or a range of IP addresses in CIDR format.
    associatedInstanceNum Number
    The number of the rocketmq instances associated with the allow list.
    associatedInstances List<Property Map>
    The associated instance information of the allow list.

    Supporting Types

    RocketMQAllowListAssociatedInstance, RocketMQAllowListAssociatedInstanceArgs

    InstanceId string
    The id of the rocketmq instance.
    InstanceName string
    The name of the rocketmq instance.
    Vpc string
    The vpc id of the rocketmq instance.
    InstanceId string
    The id of the rocketmq instance.
    InstanceName string
    The name of the rocketmq instance.
    Vpc string
    The vpc id of the rocketmq instance.
    instanceId String
    The id of the rocketmq instance.
    instanceName String
    The name of the rocketmq instance.
    vpc String
    The vpc id of the rocketmq instance.
    instanceId string
    The id of the rocketmq instance.
    instanceName string
    The name of the rocketmq instance.
    vpc string
    The vpc id of the rocketmq instance.
    instance_id str
    The id of the rocketmq instance.
    instance_name str
    The name of the rocketmq instance.
    vpc str
    The vpc id of the rocketmq instance.
    instanceId String
    The id of the rocketmq instance.
    instanceName String
    The name of the rocketmq instance.
    vpc String
    The vpc id of the rocketmq instance.

    Import

    RocketmqAllowList can be imported using the id, e.g.

    $ pulumi import volcengine:rocketmq/rocketMQAllowList:RocketMQAllowList default resource_id

    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.29 published on Tuesday, Apr 29, 2025 by Volcengine
    volcengine/pulumi-volcengine