published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
After you create an instance in the RabbitMQ console, plugins are disabled by default. You can manually enable or disable plugins for the instance. Enabling or disabling certain plugins will cause a rolling restart of the cluster. It is recommended to perform this operation outside of business hours. A rolling restart may result in the loss of non-persistent messages and temporary connection instability, such as connection drops. After a connection drop, whether the client automatically reconnects depends on its configuration
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const instancepluginDemo = new volcenginecc.rabbitmq.InstancePlugin("instancepluginDemo", {
instanceId: "rbtmq-db26b7****",
pluginName: "ccapi-test",
});
import pulumi
import pulumi_volcenginecc as volcenginecc
instanceplugin_demo = volcenginecc.rabbitmq.InstancePlugin("instancepluginDemo",
instance_id="rbtmq-db26b7****",
plugin_name="ccapi-test")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rabbitmq"
)
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 Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var instancepluginDemo = new Volcenginecc.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.volcengine.volcenginecc.rabbitmq.InstancePlugin;
import com.volcengine.volcenginecc.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: volcenginecc: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: volcenginecc: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 Volcenginecc.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 = volcenginecc.rabbitmq.InstancePlugin("instancePluginResource",
instance_id="string",
plugin_name="string")
const instancePluginResource = new volcenginecc.rabbitmq.InstancePlugin("instancePluginResource", {
instanceId: "string",
pluginName: "string",
});
type: volcenginecc: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:
- Instance
Id string - Instance ID
- Plugin
Name string - Plugin name
- Instance
Id string - Instance ID
- Plugin
Name string - Plugin name
- instance
Id String - Instance ID
- plugin
Name String - Plugin name
- instance
Id string - Instance ID
- plugin
Name string - Plugin name
- instance_
id str - Instance ID
- plugin_
name str - Plugin name
- instance
Id String - Instance ID
- plugin
Name String - Plugin name
Outputs
All input properties are implicitly available as output properties. Additionally, the InstancePlugin resource produces the following output properties:
- Description string
- Plugin description
- Disable
Prompt string - Notes for disabling this plugin
- Enable
Prompt string - Notes for enabling this plugin
- Enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- Id string
- The provider-assigned unique ID for this managed resource.
- Need
Reboot boolOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- Port int
- Plugin listening port
- Version string
- Plugin version
- Description string
- Plugin description
- Disable
Prompt string - Notes for disabling this plugin
- Enable
Prompt string - Notes for enabling this plugin
- Enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- Id string
- The provider-assigned unique ID for this managed resource.
- Need
Reboot boolOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- Port int
- Plugin listening port
- Version string
- Plugin version
- description String
- Plugin description
- disable
Prompt String - Notes for disabling this plugin
- enable
Prompt String - Notes for enabling this plugin
- enabled Boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- id String
- The provider-assigned unique ID for this managed resource.
- need
Reboot BooleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- port Integer
- Plugin listening port
- version String
- Plugin version
- description string
- Plugin description
- disable
Prompt string - Notes for disabling this plugin
- enable
Prompt string - Notes for enabling this plugin
- enabled boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- id string
- The provider-assigned unique ID for this managed resource.
- need
Reboot booleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- port number
- Plugin listening port
- version string
- Plugin version
- description str
- Plugin description
- disable_
prompt str - Notes for disabling this plugin
- enable_
prompt str - Notes for enabling this plugin
- enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- id str
- The provider-assigned unique ID for this managed resource.
- need_
reboot_ boolon_ change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- port int
- Plugin listening port
- version str
- Plugin version
- description String
- Plugin description
- disable
Prompt String - Notes for disabling this plugin
- enable
Prompt String - Notes for enabling this plugin
- enabled Boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- id String
- The provider-assigned unique ID for this managed resource.
- need
Reboot BooleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- port Number
- Plugin listening port
- version String
- Plugin version
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) -> InstancePluginfunc 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: volcenginecc: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.
- Description string
- Plugin description
- Disable
Prompt string - Notes for disabling this plugin
- Enable
Prompt string - Notes for enabling this plugin
- Enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- Instance
Id string - Instance ID
- Need
Reboot boolOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- Plugin
Name string - Plugin name
- Port int
- Plugin listening port
- Version string
- Plugin version
- Description string
- Plugin description
- Disable
Prompt string - Notes for disabling this plugin
- Enable
Prompt string - Notes for enabling this plugin
- Enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- Instance
Id string - Instance ID
- Need
Reboot boolOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- Plugin
Name string - Plugin name
- Port int
- Plugin listening port
- Version string
- Plugin version
- description String
- Plugin description
- disable
Prompt String - Notes for disabling this plugin
- enable
Prompt String - Notes for enabling this plugin
- enabled Boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- instance
Id String - Instance ID
- need
Reboot BooleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- plugin
Name String - Plugin name
- port Integer
- Plugin listening port
- version String
- Plugin version
- description string
- Plugin description
- disable
Prompt string - Notes for disabling this plugin
- enable
Prompt string - Notes for enabling this plugin
- enabled boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- instance
Id string - Instance ID
- need
Reboot booleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- plugin
Name string - Plugin name
- port number
- Plugin listening port
- version string
- Plugin version
- description str
- Plugin description
- disable_
prompt str - Notes for disabling this plugin
- enable_
prompt str - Notes for enabling this plugin
- enabled bool
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- instance_
id str - Instance ID
- need_
reboot_ boolon_ change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- plugin_
name str - Plugin name
- port int
- Plugin listening port
- version str
- Plugin version
- description String
- Plugin description
- disable
Prompt String - Notes for disabling this plugin
- enable
Prompt String - Notes for enabling this plugin
- enabled Boolean
- Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled
- instance
Id String - Instance ID
- need
Reboot BooleanOn Change - Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart
- plugin
Name String - Plugin name
- port Number
- Plugin listening port
- version String
- Plugin version
Import
$ pulumi import volcenginecc:rabbitmq/instancePlugin:InstancePlugin example "instance_id|plugin_name"
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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
