published on Thursday, Jun 25, 2026 by Pulumi
published on Thursday, Jun 25, 2026 by Pulumi
This resource allows you to enable or disable multiple RabbitMQ plugins in a single batch operation. Compared to cloudamqp.Plugin, this resource manages a set of plugins together and minimises the number of API calls by sending only what has changed on update.
Only available for dedicated subscription plans running RabbitMQ.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudamqp from "@pulumi/cloudamqp";
const instance = new cloudamqp.Instance("instance", {
name: "terraform-cloudamqp-instance",
plan: "bunny-1",
region: "amazon-web-services::us-east-1",
tags: ["terraform"],
});
const plugins = new cloudamqp.PluginBatch("plugins", {
instanceId: instance.id.apply(x =>Number(x)),
plugins: {
rabbitmq_stomp: true,
rabbitmq_top: true,
rabbitmq_web_mqtt: true,
rabbitmq_random_exchange: false,
},
});
import pulumi
import pulumi_cloudamqp as cloudamqp
instance = cloudamqp.Instance("instance",
name="terraform-cloudamqp-instance",
plan="bunny-1",
region="amazon-web-services::us-east-1",
tags=["terraform"])
plugins = cloudamqp.PluginBatch("plugins",
instance_id=instance.id.apply(lambda x: int(x)),
plugins={
"rabbitmq_stomp": True,
"rabbitmq_top": True,
"rabbitmq_web_mqtt": True,
"rabbitmq_random_exchange": False,
})
package main
import (
"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
instance, err := cloudamqp.NewInstance(ctx, "instance", &cloudamqp.InstanceArgs{
Name: pulumi.String("terraform-cloudamqp-instance"),
Plan: pulumi.String("bunny-1"),
Region: pulumi.String("amazon-web-services::us-east-1"),
Tags: pulumi.StringArray{
pulumi.String("terraform"),
},
})
if err != nil {
return err
}
_, err = cloudamqp.NewPluginBatch(ctx, "plugins", &cloudamqp.PluginBatchArgs{
InstanceId: instance.ID(),
Plugins: pulumi.BoolMap{
"rabbitmq_stomp": pulumi.Bool(true),
"rabbitmq_top": pulumi.Bool(true),
"rabbitmq_web_mqtt": pulumi.Bool(true),
"rabbitmq_random_exchange": pulumi.Bool(false),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using CloudAmqp = Pulumi.CloudAmqp;
return await Deployment.RunAsync(() =>
{
var instance = new CloudAmqp.Instance("instance", new()
{
Name = "terraform-cloudamqp-instance",
Plan = "bunny-1",
Region = "amazon-web-services::us-east-1",
Tags = new[]
{
"terraform",
},
});
var plugins = new CloudAmqp.PluginBatch("plugins", new()
{
InstanceId = instance.Id,
Plugins =
{
{ "rabbitmq_stomp", true },
{ "rabbitmq_top", true },
{ "rabbitmq_web_mqtt", true },
{ "rabbitmq_random_exchange", false },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudamqp.Instance;
import com.pulumi.cloudamqp.InstanceArgs;
import com.pulumi.cloudamqp.PluginBatch;
import com.pulumi.cloudamqp.PluginBatchArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 instance = new Instance("instance", InstanceArgs.builder()
.name("terraform-cloudamqp-instance")
.plan("bunny-1")
.region("amazon-web-services::us-east-1")
.tags("terraform")
.build());
var plugins = new PluginBatch("plugins", PluginBatchArgs.builder()
.instanceId(instance.id())
.plugins(Map.ofEntries(
Map.entry("rabbitmq_stomp", true),
Map.entry("rabbitmq_top", true),
Map.entry("rabbitmq_web_mqtt", true),
Map.entry("rabbitmq_random_exchange", false)
))
.build());
}
}
resources:
instance:
type: cloudamqp:Instance
properties:
name: terraform-cloudamqp-instance
plan: bunny-1
region: amazon-web-services::us-east-1
tags:
- terraform
plugins:
type: cloudamqp:PluginBatch
properties:
instanceId: ${instance.id}
plugins:
rabbitmq_stomp: true
rabbitmq_top: true
rabbitmq_web_mqtt: true
rabbitmq_random_exchange: false
pulumi {
required_providers {
cloudamqp = {
source = "pulumi/cloudamqp"
}
}
}
resource "cloudamqp_instance" "instance" {
name = "terraform-cloudamqp-instance"
plan = "bunny-1"
region = "amazon-web-services::us-east-1"
tags = ["terraform"]
}
resource "cloudamqp_pluginbatch" "plugins" {
instance_id = cloudamqp_instance.instance.id
plugins = {
"rabbitmq_stomp" = true
"rabbitmq_top" = true
"rabbitmq_web_mqtt" = true
"rabbitmq_random_exchange" = false
}
}
Faster instance destroy when running `terraform destroy`
Set enableFasterInstanceDestroy to true in the provider configuration to skip disabling
plugins when destroying the instance.
import * as pulumi from "@pulumi/pulumi";
import * as cloudamqp from "@pulumi/cloudamqp";
const instance = new cloudamqp.Instance("instance", {
name: "terraform-cloudamqp-instance",
plan: "bunny-1",
region: "amazon-web-services::us-east-1",
tags: ["terraform"],
});
const plugins = new cloudamqp.PluginBatch("plugins", {
instanceId: instance.id.apply(x =>Number(x)),
plugins: {
rabbitmq_stomp: true,
rabbitmq_top: true,
rabbitmq_web_mqtt: true,
},
});
import pulumi
import pulumi_cloudamqp as cloudamqp
instance = cloudamqp.Instance("instance",
name="terraform-cloudamqp-instance",
plan="bunny-1",
region="amazon-web-services::us-east-1",
tags=["terraform"])
plugins = cloudamqp.PluginBatch("plugins",
instance_id=instance.id.apply(lambda x: int(x)),
plugins={
"rabbitmq_stomp": True,
"rabbitmq_top": True,
"rabbitmq_web_mqtt": True,
})
package main
import (
"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
instance, err := cloudamqp.NewInstance(ctx, "instance", &cloudamqp.InstanceArgs{
Name: pulumi.String("terraform-cloudamqp-instance"),
Plan: pulumi.String("bunny-1"),
Region: pulumi.String("amazon-web-services::us-east-1"),
Tags: pulumi.StringArray{
pulumi.String("terraform"),
},
})
if err != nil {
return err
}
_, err = cloudamqp.NewPluginBatch(ctx, "plugins", &cloudamqp.PluginBatchArgs{
InstanceId: instance.ID(),
Plugins: pulumi.BoolMap{
"rabbitmq_stomp": pulumi.Bool(true),
"rabbitmq_top": pulumi.Bool(true),
"rabbitmq_web_mqtt": pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using CloudAmqp = Pulumi.CloudAmqp;
return await Deployment.RunAsync(() =>
{
var instance = new CloudAmqp.Instance("instance", new()
{
Name = "terraform-cloudamqp-instance",
Plan = "bunny-1",
Region = "amazon-web-services::us-east-1",
Tags = new[]
{
"terraform",
},
});
var plugins = new CloudAmqp.PluginBatch("plugins", new()
{
InstanceId = instance.Id,
Plugins =
{
{ "rabbitmq_stomp", true },
{ "rabbitmq_top", true },
{ "rabbitmq_web_mqtt", true },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudamqp.Instance;
import com.pulumi.cloudamqp.InstanceArgs;
import com.pulumi.cloudamqp.PluginBatch;
import com.pulumi.cloudamqp.PluginBatchArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 instance = new Instance("instance", InstanceArgs.builder()
.name("terraform-cloudamqp-instance")
.plan("bunny-1")
.region("amazon-web-services::us-east-1")
.tags("terraform")
.build());
var plugins = new PluginBatch("plugins", PluginBatchArgs.builder()
.instanceId(instance.id())
.plugins(Map.ofEntries(
Map.entry("rabbitmq_stomp", true),
Map.entry("rabbitmq_top", true),
Map.entry("rabbitmq_web_mqtt", true)
))
.build());
}
}
resources:
instance:
type: cloudamqp:Instance
properties:
name: terraform-cloudamqp-instance
plan: bunny-1
region: amazon-web-services::us-east-1
tags:
- terraform
plugins:
type: cloudamqp:PluginBatch
properties:
instanceId: ${instance.id}
plugins:
rabbitmq_stomp: true
rabbitmq_top: true
rabbitmq_web_mqtt: true
pulumi {
required_providers {
cloudamqp = {
source = "pulumi/cloudamqp"
}
}
}
resource "cloudamqp_instance" "instance" {
name = "terraform-cloudamqp-instance"
plan = "bunny-1"
region = "amazon-web-services::us-east-1"
tags = ["terraform"]
}
resource "cloudamqp_pluginbatch" "plugins" {
instance_id = cloudamqp_instance.instance.id
plugins = {
"rabbitmq_stomp" = true
"rabbitmq_top" = true
"rabbitmq_web_mqtt" = true
}
}
Behaviour
Create
Sends an enable request containing all plugins in the map with value true.
Update
Computes the minimal diff between the previous and desired state:
- Plugins changed to
true(or newly added astrue) are sent in the enable list. - Plugins changed to
false(or removed from the map, treated as disabled) are sent in the disable list.
Only the changed plugins are sent to the API, keeping the request as small as possible.
Delete
Sends a disable request for all plugins in the map with value true. Plugins already set to
false are ignored.
Dependency
This resource depends on the CloudAMQP instance identifier, cloudamqp_instance.instance.id.
Enable faster instance destroy
When running terraform destroy this resource will try to disable the managed plugins before
deleting cloudamqp.Instance. This is not necessary since the servers will be deleted.
Set enableFasterInstanceDestroy to true in the provider configuration to skip this.
Required plugins
The following plugins are always enabled by CloudAMQP and do not need to be managed:
| Name | Version |
|---|---|
| rabbitmqManagement | all |
| rabbitmqManagementAgent | all |
| rabbitmqPrometheus | 3.10.0 |
| rabbitmqWebDispatch | all |
Create PluginBatch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PluginBatch(name: string, args: PluginBatchArgs, opts?: CustomResourceOptions);@overload
def PluginBatch(resource_name: str,
args: PluginBatchArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PluginBatch(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[int] = None,
plugins: Optional[Mapping[str, bool]] = None,
sleep: Optional[int] = None,
timeout: Optional[int] = None)func NewPluginBatch(ctx *Context, name string, args PluginBatchArgs, opts ...ResourceOption) (*PluginBatch, error)public PluginBatch(string name, PluginBatchArgs args, CustomResourceOptions? opts = null)
public PluginBatch(String name, PluginBatchArgs args)
public PluginBatch(String name, PluginBatchArgs args, CustomResourceOptions options)
type: cloudamqp:PluginBatch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "cloudamqp_pluginbatch" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PluginBatchArgs
- 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 PluginBatchArgs
- 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 PluginBatchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PluginBatchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PluginBatchArgs
- 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 pluginBatchResource = new CloudAmqp.PluginBatch("pluginBatchResource", new()
{
InstanceId = 0,
Plugins =
{
{ "string", false },
},
Sleep = 0,
Timeout = 0,
});
example, err := cloudamqp.NewPluginBatch(ctx, "pluginBatchResource", &cloudamqp.PluginBatchArgs{
InstanceId: pulumi.Int(0),
Plugins: pulumi.BoolMap{
"string": pulumi.Bool(false),
},
Sleep: pulumi.Int(0),
Timeout: pulumi.Int(0),
})
resource "cloudamqp_pluginbatch" "pluginBatchResource" {
instance_id = 0
plugins = {
"string" = false
}
sleep = 0
timeout = 0
}
var pluginBatchResource = new PluginBatch("pluginBatchResource", PluginBatchArgs.builder()
.instanceId(0)
.plugins(Map.of("string", false))
.sleep(0)
.timeout(0)
.build());
plugin_batch_resource = cloudamqp.PluginBatch("pluginBatchResource",
instance_id=0,
plugins={
"string": False,
},
sleep=0,
timeout=0)
const pluginBatchResource = new cloudamqp.PluginBatch("pluginBatchResource", {
instanceId: 0,
plugins: {
string: false,
},
sleep: 0,
timeout: 0,
});
type: cloudamqp:PluginBatch
properties:
instanceId: 0
plugins:
string: false
sleep: 0
timeout: 0
PluginBatch 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 PluginBatch resource accepts the following input properties:
- Instance
Id int - The CloudAMQP instance ID.
- Plugins Dictionary<string, bool>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - Sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- Timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- Instance
Id int - The CloudAMQP instance ID.
- Plugins map[string]bool
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - Sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- Timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance_
id number - The CloudAMQP instance ID.
- plugins map(bool)
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id Integer - The CloudAMQP instance ID.
- plugins Map<String,Boolean>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep Integer
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout Integer
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id number - The CloudAMQP instance ID.
- plugins {[key: string]: boolean}
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance_
id int - The CloudAMQP instance ID.
- plugins Mapping[str, bool]
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id Number - The CloudAMQP instance ID.
- plugins Map<Boolean>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep Number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout Number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
Outputs
All input properties are implicitly available as output properties. Additionally, the PluginBatch 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 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 PluginBatch Resource
Get an existing PluginBatch 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?: PluginBatchState, opts?: CustomResourceOptions): PluginBatch@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[int] = None,
plugins: Optional[Mapping[str, bool]] = None,
sleep: Optional[int] = None,
timeout: Optional[int] = None) -> PluginBatchfunc GetPluginBatch(ctx *Context, name string, id IDInput, state *PluginBatchState, opts ...ResourceOption) (*PluginBatch, error)public static PluginBatch Get(string name, Input<string> id, PluginBatchState? state, CustomResourceOptions? opts = null)public static PluginBatch get(String name, Output<String> id, PluginBatchState state, CustomResourceOptions options)resources: _: type: cloudamqp:PluginBatch get: id: ${id}import {
to = cloudamqp_pluginbatch.example
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.
- Instance
Id int - The CloudAMQP instance ID.
- Plugins Dictionary<string, bool>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - Sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- Timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- Instance
Id int - The CloudAMQP instance ID.
- Plugins map[string]bool
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - Sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- Timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance_
id number - The CloudAMQP instance ID.
- plugins map(bool)
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id Integer - The CloudAMQP instance ID.
- plugins Map<String,Boolean>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep Integer
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout Integer
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id number - The CloudAMQP instance ID.
- plugins {[key: string]: boolean}
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance_
id int - The CloudAMQP instance ID.
- plugins Mapping[str, bool]
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep int
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout int
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
- instance
Id Number - The CloudAMQP instance ID.
- plugins Map<Boolean>
- A map of plugin name to enabled state. Set a plugin to
trueto enable it, orfalseto disable it. Only the plugins listed in this map are managed by this resource; all other plugins on the instance are left untouched. - sleep Number
- Configurable sleep time (seconds) used when polling for job completion. Default set to 10 seconds.
- timeout Number
- Configurable timeout time (seconds) for the operation. Default set to 1800 seconds.
Import
Not possible to import this resource.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- CloudAMQP pulumi/pulumi-cloudamqp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudamqpTerraform Provider.
published on Thursday, Jun 25, 2026 by Pulumi