Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. RabbitConfiguration
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.RabbitConfiguration

Explore with Pulumi AI

CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

Import

cloudamqp_rabbitmq_configuration can be imported using the CloudAMQP instance identifier. To

retrieve the identifier, use [CloudAMQP API list intances].

From Terraform v1.5.0, the import block can be used to import this resource:

hcl

import {

to = cloudamqp_rabbitmq_configuration.config

id = cloudamqp_instance.instance.id

}

Or use Terraform CLI:

$ pulumi import cloudamqp:index/rabbitConfiguration:RabbitConfiguration config <instance_id>`
Copy

Create RabbitConfiguration Resource

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

Constructor syntax

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

@overload
def RabbitConfiguration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        instance_id: Optional[int] = None,
                        channel_max: Optional[int] = None,
                        cluster_partition_handling: Optional[str] = None,
                        connection_max: Optional[int] = None,
                        consumer_timeout: Optional[int] = None,
                        heartbeat: Optional[int] = None,
                        log_exchange_level: Optional[str] = None,
                        max_message_size: Optional[int] = None,
                        queue_index_embed_msgs_below: Optional[int] = None,
                        sleep: Optional[int] = None,
                        timeout: Optional[int] = None,
                        vm_memory_high_watermark: Optional[float] = None)
func NewRabbitConfiguration(ctx *Context, name string, args RabbitConfigurationArgs, opts ...ResourceOption) (*RabbitConfiguration, error)
public RabbitConfiguration(string name, RabbitConfigurationArgs args, CustomResourceOptions? opts = null)
public RabbitConfiguration(String name, RabbitConfigurationArgs args)
public RabbitConfiguration(String name, RabbitConfigurationArgs args, CustomResourceOptions options)

type: cloudamqp:RabbitConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RabbitConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RabbitConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RabbitConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RabbitConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RabbitConfigurationArgs
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 rabbitConfigurationResource = new CloudAmqp.RabbitConfiguration("rabbitConfigurationResource", new()
{
    InstanceId = 0,
    ChannelMax = 0,
    ClusterPartitionHandling = "string",
    ConnectionMax = 0,
    ConsumerTimeout = 0,
    Heartbeat = 0,
    LogExchangeLevel = "string",
    MaxMessageSize = 0,
    QueueIndexEmbedMsgsBelow = 0,
    Sleep = 0,
    Timeout = 0,
    VmMemoryHighWatermark = 0,
});
Copy
example, err := cloudamqp.NewRabbitConfiguration(ctx, "rabbitConfigurationResource", &cloudamqp.RabbitConfigurationArgs{
	InstanceId:               pulumi.Int(0),
	ChannelMax:               pulumi.Int(0),
	ClusterPartitionHandling: pulumi.String("string"),
	ConnectionMax:            pulumi.Int(0),
	ConsumerTimeout:          pulumi.Int(0),
	Heartbeat:                pulumi.Int(0),
	LogExchangeLevel:         pulumi.String("string"),
	MaxMessageSize:           pulumi.Int(0),
	QueueIndexEmbedMsgsBelow: pulumi.Int(0),
	Sleep:                    pulumi.Int(0),
	Timeout:                  pulumi.Int(0),
	VmMemoryHighWatermark:    pulumi.Float64(0),
})
Copy
var rabbitConfigurationResource = new RabbitConfiguration("rabbitConfigurationResource", RabbitConfigurationArgs.builder()
    .instanceId(0)
    .channelMax(0)
    .clusterPartitionHandling("string")
    .connectionMax(0)
    .consumerTimeout(0)
    .heartbeat(0)
    .logExchangeLevel("string")
    .maxMessageSize(0)
    .queueIndexEmbedMsgsBelow(0)
    .sleep(0)
    .timeout(0)
    .vmMemoryHighWatermark(0)
    .build());
Copy
rabbit_configuration_resource = cloudamqp.RabbitConfiguration("rabbitConfigurationResource",
    instance_id=0,
    channel_max=0,
    cluster_partition_handling="string",
    connection_max=0,
    consumer_timeout=0,
    heartbeat=0,
    log_exchange_level="string",
    max_message_size=0,
    queue_index_embed_msgs_below=0,
    sleep=0,
    timeout=0,
    vm_memory_high_watermark=0)
Copy
const rabbitConfigurationResource = new cloudamqp.RabbitConfiguration("rabbitConfigurationResource", {
    instanceId: 0,
    channelMax: 0,
    clusterPartitionHandling: "string",
    connectionMax: 0,
    consumerTimeout: 0,
    heartbeat: 0,
    logExchangeLevel: "string",
    maxMessageSize: 0,
    queueIndexEmbedMsgsBelow: 0,
    sleep: 0,
    timeout: 0,
    vmMemoryHighWatermark: 0,
});
Copy
type: cloudamqp:RabbitConfiguration
properties:
    channelMax: 0
    clusterPartitionHandling: string
    connectionMax: 0
    consumerTimeout: 0
    heartbeat: 0
    instanceId: 0
    logExchangeLevel: string
    maxMessageSize: 0
    queueIndexEmbedMsgsBelow: 0
    sleep: 0
    timeout: 0
    vmMemoryHighWatermark: 0
Copy

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

InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
ChannelMax int
Set the maximum permissible number of channels per connection.
ClusterPartitionHandling string
Set how the cluster should handle network partition.
ConnectionMax int
Set the maximum permissible number of connection.
ConsumerTimeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
Heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
LogExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

MaxMessageSize int
The largest allowed message payload size in bytes.
QueueIndexEmbedMsgsBelow int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
Sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
Timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
VmMemoryHighWatermark double
When the server will enter memory based flow-control as relative to the maximum available memory.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
ChannelMax int
Set the maximum permissible number of channels per connection.
ClusterPartitionHandling string
Set how the cluster should handle network partition.
ConnectionMax int
Set the maximum permissible number of connection.
ConsumerTimeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
Heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
LogExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

MaxMessageSize int
The largest allowed message payload size in bytes.
QueueIndexEmbedMsgsBelow int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
Sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
Timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
VmMemoryHighWatermark float64
When the server will enter memory based flow-control as relative to the maximum available memory.
instanceId
This property is required.
Changes to this property will trigger replacement.
Integer
The CloudAMQP instance ID.
channelMax Integer
Set the maximum permissible number of channels per connection.
clusterPartitionHandling String
Set how the cluster should handle network partition.
connectionMax Integer
Set the maximum permissible number of connection.
consumerTimeout Integer
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat Integer
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
logExchangeLevel String

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize Integer
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow Integer
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep Integer
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout Integer
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark Double
When the server will enter memory based flow-control as relative to the maximum available memory.
instanceId
This property is required.
Changes to this property will trigger replacement.
number
The CloudAMQP instance ID.
channelMax number
Set the maximum permissible number of channels per connection.
clusterPartitionHandling string
Set how the cluster should handle network partition.
connectionMax number
Set the maximum permissible number of connection.
consumerTimeout number
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat number
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
logExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize number
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow number
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep number
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout number
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark number
When the server will enter memory based flow-control as relative to the maximum available memory.
instance_id
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
channel_max int
Set the maximum permissible number of channels per connection.
cluster_partition_handling str
Set how the cluster should handle network partition.
connection_max int
Set the maximum permissible number of connection.
consumer_timeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
log_exchange_level str

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

max_message_size int
The largest allowed message payload size in bytes.
queue_index_embed_msgs_below int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vm_memory_high_watermark float
When the server will enter memory based flow-control as relative to the maximum available memory.
instanceId
This property is required.
Changes to this property will trigger replacement.
Number
The CloudAMQP instance ID.
channelMax Number
Set the maximum permissible number of channels per connection.
clusterPartitionHandling String
Set how the cluster should handle network partition.
connectionMax Number
Set the maximum permissible number of connection.
consumerTimeout Number
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat Number
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
logExchangeLevel String

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize Number
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow Number
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep Number
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout Number
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark Number
When the server will enter memory based flow-control as relative to the maximum available memory.

Outputs

All input properties are implicitly available as output properties. Additionally, the RabbitConfiguration 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing RabbitConfiguration Resource

Get an existing RabbitConfiguration 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?: RabbitConfigurationState, opts?: CustomResourceOptions): RabbitConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        channel_max: Optional[int] = None,
        cluster_partition_handling: Optional[str] = None,
        connection_max: Optional[int] = None,
        consumer_timeout: Optional[int] = None,
        heartbeat: Optional[int] = None,
        instance_id: Optional[int] = None,
        log_exchange_level: Optional[str] = None,
        max_message_size: Optional[int] = None,
        queue_index_embed_msgs_below: Optional[int] = None,
        sleep: Optional[int] = None,
        timeout: Optional[int] = None,
        vm_memory_high_watermark: Optional[float] = None) -> RabbitConfiguration
func GetRabbitConfiguration(ctx *Context, name string, id IDInput, state *RabbitConfigurationState, opts ...ResourceOption) (*RabbitConfiguration, error)
public static RabbitConfiguration Get(string name, Input<string> id, RabbitConfigurationState? state, CustomResourceOptions? opts = null)
public static RabbitConfiguration get(String name, Output<String> id, RabbitConfigurationState state, CustomResourceOptions options)
resources:  _:    type: cloudamqp:RabbitConfiguration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ChannelMax int
Set the maximum permissible number of channels per connection.
ClusterPartitionHandling string
Set how the cluster should handle network partition.
ConnectionMax int
Set the maximum permissible number of connection.
ConsumerTimeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
Heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
LogExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

MaxMessageSize int
The largest allowed message payload size in bytes.
QueueIndexEmbedMsgsBelow int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
Sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
Timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
VmMemoryHighWatermark double
When the server will enter memory based flow-control as relative to the maximum available memory.
ChannelMax int
Set the maximum permissible number of channels per connection.
ClusterPartitionHandling string
Set how the cluster should handle network partition.
ConnectionMax int
Set the maximum permissible number of connection.
ConsumerTimeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
Heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
LogExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

MaxMessageSize int
The largest allowed message payload size in bytes.
QueueIndexEmbedMsgsBelow int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
Sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
Timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
VmMemoryHighWatermark float64
When the server will enter memory based flow-control as relative to the maximum available memory.
channelMax Integer
Set the maximum permissible number of channels per connection.
clusterPartitionHandling String
Set how the cluster should handle network partition.
connectionMax Integer
Set the maximum permissible number of connection.
consumerTimeout Integer
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat Integer
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
instanceId Changes to this property will trigger replacement. Integer
The CloudAMQP instance ID.
logExchangeLevel String

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize Integer
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow Integer
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep Integer
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout Integer
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark Double
When the server will enter memory based flow-control as relative to the maximum available memory.
channelMax number
Set the maximum permissible number of channels per connection.
clusterPartitionHandling string
Set how the cluster should handle network partition.
connectionMax number
Set the maximum permissible number of connection.
consumerTimeout number
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat number
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
instanceId Changes to this property will trigger replacement. number
The CloudAMQP instance ID.
logExchangeLevel string

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize number
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow number
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep number
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout number
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark number
When the server will enter memory based flow-control as relative to the maximum available memory.
channel_max int
Set the maximum permissible number of channels per connection.
cluster_partition_handling str
Set how the cluster should handle network partition.
connection_max int
Set the maximum permissible number of connection.
consumer_timeout int
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat int
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
instance_id Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
log_exchange_level str

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

max_message_size int
The largest allowed message payload size in bytes.
queue_index_embed_msgs_below int
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep int
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout int
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vm_memory_high_watermark float
When the server will enter memory based flow-control as relative to the maximum available memory.
channelMax Number
Set the maximum permissible number of channels per connection.
clusterPartitionHandling String
Set how the cluster should handle network partition.
connectionMax Number
Set the maximum permissible number of connection.
consumerTimeout Number
A consumer that has recevied a message and does not acknowledge that message within the timeout in milliseconds
heartbeat Number
Set the server AMQP 0-9-1 heartbeat timeout in seconds.
instanceId Changes to this property will trigger replacement. Number
The CloudAMQP instance ID.
logExchangeLevel String

Log level for the logger used for log integrations and the CloudAMQP Console log view.

Note: Requires a restart of RabbitMQ to be applied.

maxMessageSize Number
The largest allowed message payload size in bytes.
queueIndexEmbedMsgsBelow Number
Size in bytes below which to embed messages in the queue index. 0 will turn off payload embedding in the queue index.
sleep Number
Configurable sleep time in seconds between retries for RabbitMQ configuration. Default set to 60 seconds.
timeout Number
Configurable timeout time in seconds for RabbitMQ configuration. Default set to 3600 seconds.
vmMemoryHighWatermark Number
When the server will enter memory based flow-control as relative to the maximum available memory.

Package Details

Repository
CloudAMQP pulumi/pulumi-cloudamqp
License
Apache-2.0
Notes
This Pulumi package is based on the cloudamqp Terraform Provider.
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp