1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. rabbitmq
  5. InstancePlugin
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.rabbitmq.InstancePlugin

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    在消息队列 RabbitMQ版控制台中创建实例之后，实例插件默认为关闭状态，您可以手动为实例开启/关闭插件。开启/关闭部分插件会导致集群滚动重启，建议避开业务运行时段执行该操作。集群滚动重启时会造成未持久化的消息丢失，也会出现短暂的连接不稳定现象，例如连接断开，断开后会根据客户端配置决定是否自动重连。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const instancepluginDemo = new bytepluscc.rabbitmq.InstancePlugin("instancepluginDemo", {
    instanceId: "rbtmq-db26b7****",
    pluginName: "ccapi-test",
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

instanceplugin_demo = bytepluscc.rabbitmq.InstancePlugin("instancepluginDemo",
    instance_id="rbtmq-db26b7****",
    plugin_name="ccapi-test")

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/rabbitmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rabbitmq.NewInstancePlugin(ctx, "instancepluginDemo", &rabbitmq.InstancePluginArgs{
			InstanceId: pulumi.String("rbtmq-db26b7****"),
			PluginName: pulumi.String("ccapi-test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var instancepluginDemo = new Bytepluscc.Rabbitmq.InstancePlugin("instancepluginDemo", new()
    {
        InstanceId = "rbtmq-db26b7****",
        PluginName = "ccapi-test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.rabbitmq.InstancePlugin;
import com.byteplus.bytepluscc.rabbitmq.InstancePluginArgs;
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 instancepluginDemo = new InstancePlugin("instancepluginDemo", InstancePluginArgs.builder()
            .instanceId("rbtmq-db26b7****")
            .pluginName("ccapi-test")
            .build());

    }
}

    resources:
  instancepluginDemo:
    type: bytepluscc:rabbitmq:InstancePlugin
    properties:
      instanceId: rbtmq-db26b7****
      pluginName: ccapi-test

    Create InstancePlugin Resource

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

    Constructor syntax

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

@overload
def InstancePlugin(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[str] = None,
                   plugin_name: Optional[str] = None)
    func NewInstancePlugin(ctx *Context, name string, args InstancePluginArgs, opts ...ResourceOption) (*InstancePlugin, error)
    public InstancePlugin(string name, InstancePluginArgs args, CustomResourceOptions? opts = null)
    public InstancePlugin(String name, InstancePluginArgs args)
public InstancePlugin(String name, InstancePluginArgs args, CustomResourceOptions options)

    type: bytepluscc:rabbitmq:InstancePlugin
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 InstancePluginArgs
    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 InstancePluginArgs
    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 InstancePluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstancePluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstancePluginArgs
    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 instancePluginResource = new Bytepluscc.Rabbitmq.InstancePlugin("instancePluginResource", new()
{
    InstanceId = "string",
    PluginName = "string",
});

    example, err := rabbitmq.NewInstancePlugin(ctx, "instancePluginResource", &rabbitmq.InstancePluginArgs{
	InstanceId: pulumi.String("string"),
	PluginName: pulumi.String("string"),
})

    var instancePluginResource = new InstancePlugin("instancePluginResource", InstancePluginArgs.builder()
    .instanceId("string")
    .pluginName("string")
    .build());

    instance_plugin_resource = bytepluscc.rabbitmq.InstancePlugin("instancePluginResource",
    instance_id="string",
    plugin_name="string")

    const instancePluginResource = new bytepluscc.rabbitmq.InstancePlugin("instancePluginResource", {
    instanceId: "string",
    pluginName: "string",
});

    type: bytepluscc:rabbitmq:InstancePlugin
properties:
    instanceId: string
    pluginName: string

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

    InstanceId string
    实例 ID。
    PluginName string
    插件名称。
    InstanceId string
    实例 ID。
    PluginName string
    插件名称。
    instanceId String
    实例 ID。
    pluginName String
    插件名称。
    instanceId string
    实例 ID。
    pluginName string
    插件名称。
    instance_id str
    实例 ID。
    plugin_name str
    插件名称。
    instanceId String
    实例 ID。
    pluginName String
    插件名称。

    Outputs

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

    Description string
    插件描述。
    DisablePrompt string
    关闭此插件的注意事项说明。
    EnablePrompt string
    开启此插件的注意事项说明。
    Enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    Id string
    The provider-assigned unique ID for this managed resource.
    NeedRebootOnChange bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    Port int
    插件监听的端口。
    Version string
    插件版本。
    Description string
    插件描述。
    DisablePrompt string
    关闭此插件的注意事项说明。
    EnablePrompt string
    开启此插件的注意事项说明。
    Enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    Id string
    The provider-assigned unique ID for this managed resource.
    NeedRebootOnChange bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    Port int
    插件监听的端口。
    Version string
    插件版本。
    description String
    插件描述。
    disablePrompt String
    关闭此插件的注意事项说明。
    enablePrompt String
    开启此插件的注意事项说明。
    enabled Boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    id String
    The provider-assigned unique ID for this managed resource.
    needRebootOnChange Boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    port Integer
    插件监听的端口。
    version String
    插件版本。
    description string
    插件描述。
    disablePrompt string
    关闭此插件的注意事项说明。
    enablePrompt string
    开启此插件的注意事项说明。
    enabled boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    id string
    The provider-assigned unique ID for this managed resource.
    needRebootOnChange boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    port number
    插件监听的端口。
    version string
    插件版本。
    description str
    插件描述。
    disable_prompt str
    关闭此插件的注意事项说明。
    enable_prompt str
    开启此插件的注意事项说明。
    enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    id str
    The provider-assigned unique ID for this managed resource.
    need_reboot_on_change bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    port int
    插件监听的端口。
    version str
    插件版本。
    description String
    插件描述。
    disablePrompt String
    关闭此插件的注意事项说明。
    enablePrompt String
    开启此插件的注意事项说明。
    enabled Boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    id String
    The provider-assigned unique ID for this managed resource.
    needRebootOnChange Boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    port Number
    插件监听的端口。
    version String
    插件版本。

    Look up Existing InstancePlugin Resource

    Get an existing InstancePlugin 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?: InstancePluginState, opts?: CustomResourceOptions): InstancePlugin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_prompt: Optional[str] = None,
        enable_prompt: Optional[str] = None,
        enabled: Optional[bool] = None,
        instance_id: Optional[str] = None,
        need_reboot_on_change: Optional[bool] = None,
        plugin_name: Optional[str] = None,
        port: Optional[int] = None,
        version: Optional[str] = None) -> InstancePlugin
    func GetInstancePlugin(ctx *Context, name string, id IDInput, state *InstancePluginState, opts ...ResourceOption) (*InstancePlugin, error)
    public static InstancePlugin Get(string name, Input<string> id, InstancePluginState? state, CustomResourceOptions? opts = null)
    public static InstancePlugin get(String name, Output<String> id, InstancePluginState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:rabbitmq:InstancePlugin    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
    插件描述。
    DisablePrompt string
    关闭此插件的注意事项说明。
    EnablePrompt string
    开启此插件的注意事项说明。
    Enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    InstanceId string
    实例 ID。
    NeedRebootOnChange bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    PluginName string
    插件名称。
    Port int
    插件监听的端口。
    Version string
    插件版本。
    Description string
    插件描述。
    DisablePrompt string
    关闭此插件的注意事项说明。
    EnablePrompt string
    开启此插件的注意事项说明。
    Enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    InstanceId string
    实例 ID。
    NeedRebootOnChange bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    PluginName string
    插件名称。
    Port int
    插件监听的端口。
    Version string
    插件版本。
    description String
    插件描述。
    disablePrompt String
    关闭此插件的注意事项说明。
    enablePrompt String
    开启此插件的注意事项说明。
    enabled Boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    instanceId String
    实例 ID。
    needRebootOnChange Boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    pluginName String
    插件名称。
    port Integer
    插件监听的端口。
    version String
    插件版本。
    description string
    插件描述。
    disablePrompt string
    关闭此插件的注意事项说明。
    enablePrompt string
    开启此插件的注意事项说明。
    enabled boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    instanceId string
    实例 ID。
    needRebootOnChange boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    pluginName string
    插件名称。
    port number
    插件监听的端口。
    version string
    插件版本。
    description str
    插件描述。
    disable_prompt str
    关闭此插件的注意事项说明。
    enable_prompt str
    开启此插件的注意事项说明。
    enabled bool
    是否已开启插件。true：插件已开启。false：插件已关闭。
    instance_id str
    实例 ID。
    need_reboot_on_change bool
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    plugin_name str
    插件名称。
    port int
    插件监听的端口。
    version str
    插件版本。
    description String
    插件描述。
    disablePrompt String
    关闭此插件的注意事项说明。
    enablePrompt String
    开启此插件的注意事项说明。
    enabled Boolean
    是否已开启插件。true：插件已开启。false：插件已关闭。
    instanceId String
    实例 ID。
    needRebootOnChange Boolean
    开启或关闭插件是否会引发 RabbitMQ 实例重启。true：会重启实例。false：不会重启实例。
    pluginName String
    插件名称。
    port Number
    插件监听的端口。
    version String
    插件版本。

    Import

    $ pulumi import bytepluscc:rabbitmq/instancePlugin:InstancePlugin example "instance_id|plugin_name"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.