Pulumi RabbitMQ

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-rabbitmq repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-rabbitmq repo.

class pulumi_rabbitmq.Binding(resource_name, opts=None, arguments=None, destination=None, destination_type=None, routing_key=None, source=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .Binding resource creates and manages a binding relationship between a queue an exchange.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arguments (pulumi.Input[dict]) – Additional key/value arguments for the binding.

  • destination (pulumi.Input[str]) – The destination queue or exchange.

  • destination_type (pulumi.Input[str]) – The type of destination (queue or exchange).

  • routing_key (pulumi.Input[str]) – A routing key for the binding.

  • source (pulumi.Input[str]) – The source exchange.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

arguments = None

Additional key/value arguments for the binding.

destination = None

The destination queue or exchange.

destination_type = None

The type of destination (queue or exchange).

properties_key = None

A unique key to refer to the binding.

routing_key = None

A routing key for the binding.

source = None

The source exchange.

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, arguments=None, destination=None, destination_type=None, properties_key=None, routing_key=None, source=None, vhost=None)

Get an existing Binding resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arguments (pulumi.Input[dict]) – Additional key/value arguments for the binding.

  • destination (pulumi.Input[str]) – The destination queue or exchange.

  • destination_type (pulumi.Input[str]) – The type of destination (queue or exchange).

  • properties_key (pulumi.Input[str]) – A unique key to refer to the binding.

  • routing_key (pulumi.Input[str]) – A routing key for the binding.

  • source (pulumi.Input[str]) – The source exchange.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.Exchange(resource_name, opts=None, name=None, settings=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .Exchange resource creates and manages an exchange.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the exchange.

  • settings (pulumi.Input[dict]) – The settings of the exchange. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The settings object supports the following:

  • arguments (pulumi.Input[dict])

  • autoDelete (pulumi.Input[bool])

  • durable (pulumi.Input[bool])

  • type (pulumi.Input[str])

name = None

The name of the exchange.

settings = None

The settings of the exchange. The structure is described below.

  • arguments (dict)

  • autoDelete (bool)

  • durable (bool)

  • type (str)

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, name=None, settings=None, vhost=None)

Get an existing Exchange resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the exchange.

  • settings (pulumi.Input[dict]) – The settings of the exchange. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The settings object supports the following:

  • arguments (pulumi.Input[dict])

  • autoDelete (pulumi.Input[bool])

  • durable (pulumi.Input[bool])

  • type (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.Permissions(resource_name, opts=None, permissions=None, user=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .Permissions resource creates and manages a user’s set of permissions.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • permissions (pulumi.Input[dict]) – The settings of the permissions. The structure is described below.

  • user (pulumi.Input[str]) – The user to apply the permissions to.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The permissions object supports the following:

  • configure (pulumi.Input[str])

  • read (pulumi.Input[str])

  • write (pulumi.Input[str])

permissions = None

The settings of the permissions. The structure is described below.

  • configure (str)

  • read (str)

  • write (str)

user = None

The user to apply the permissions to.

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, permissions=None, user=None, vhost=None)

Get an existing Permissions resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • permissions (pulumi.Input[dict]) – The settings of the permissions. The structure is described below.

  • user (pulumi.Input[str]) – The user to apply the permissions to.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The permissions object supports the following:

  • configure (pulumi.Input[str])

  • read (pulumi.Input[str])

  • write (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.Policy(resource_name, opts=None, name=None, policy=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .Policy resource creates and manages policies for exchanges and queues.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the policy.

  • policy (pulumi.Input[dict]) – The settings of the policy. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The policy object supports the following:

  • applyTo (pulumi.Input[str])

  • definition (pulumi.Input[dict])

  • pattern (pulumi.Input[str])

  • priority (pulumi.Input[float])

name = None

The name of the policy.

policy = None

The settings of the policy. The structure is described below.

  • applyTo (str)

  • definition (dict)

  • pattern (str)

  • priority (float)

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, name=None, policy=None, vhost=None)

Get an existing Policy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the policy.

  • policy (pulumi.Input[dict]) – The settings of the policy. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The policy object supports the following:

  • applyTo (pulumi.Input[str])

  • definition (pulumi.Input[dict])

  • pattern (pulumi.Input[str])

  • priority (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.Provider(resource_name, opts=None, cacert_file=None, endpoint=None, insecure=None, password=None, username=None, __props__=None, __name__=None, __opts__=None)

The provider type for the rabbitmq package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.Queue(resource_name, opts=None, name=None, settings=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .Queue resource creates and manages a queue.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the queue.

  • settings (pulumi.Input[dict]) – The settings of the queue. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The settings object supports the following:

  • arguments (pulumi.Input[dict])

  • argumentsJson (pulumi.Input[str])

  • autoDelete (pulumi.Input[bool])

  • durable (pulumi.Input[bool])

name = None

The name of the queue.

settings = None

The settings of the queue. The structure is described below.

  • arguments (dict)

  • argumentsJson (str)

  • autoDelete (bool)

  • durable (bool)

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, name=None, settings=None, vhost=None)

Get an existing Queue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the queue.

  • settings (pulumi.Input[dict]) – The settings of the queue. The structure is described below.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The settings object supports the following:

  • arguments (pulumi.Input[dict])

  • argumentsJson (pulumi.Input[str])

  • autoDelete (pulumi.Input[bool])

  • durable (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.TopicPermissions(resource_name, opts=None, permissions=None, user=None, vhost=None, __props__=None, __name__=None, __opts__=None)

The .TopicPermissions resource creates and manages a user’s set of topic permissions.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • permissions (pulumi.Input[list]) – The settings of the permissions. The structure is described below.

  • user (pulumi.Input[str]) – The user to apply the permissions to.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The permissions object supports the following:

  • exchange (pulumi.Input[str])

  • read (pulumi.Input[str])

  • write (pulumi.Input[str])

permissions = None

The settings of the permissions. The structure is described below.

  • exchange (str)

  • read (str)

  • write (str)

user = None

The user to apply the permissions to.

vhost = None

The vhost to create the resource in.

static get(resource_name, id, opts=None, permissions=None, user=None, vhost=None)

Get an existing TopicPermissions resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • permissions (pulumi.Input[list]) – The settings of the permissions. The structure is described below.

  • user (pulumi.Input[str]) – The user to apply the permissions to.

  • vhost (pulumi.Input[str]) – The vhost to create the resource in.

The permissions object supports the following:

  • exchange (pulumi.Input[str])

  • read (pulumi.Input[str])

  • write (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.User(resource_name, opts=None, name=None, password=None, tags=None, __props__=None, __name__=None, __opts__=None)

The .User resource creates and manages a user.

Note: All arguments including username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

This content is derived from https://github.com/terraform-providers/terraform-provider-rabbitmq/blob/master/website/docs/r/user.html.markdown.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the user.

  • password (pulumi.Input[str]) – The password of the user. The value of this argument is plain-text so make sure to secure where this is defined.

  • tags (pulumi.Input[list]) – Which permission model to apply to the user. Valid options are: management, policymaker, monitoring, and administrator.

name = None

The name of the user.

password = None

The password of the user. The value of this argument is plain-text so make sure to secure where this is defined.

tags = None

Which permission model to apply to the user. Valid options are: management, policymaker, monitoring, and administrator.

static get(resource_name, id, opts=None, name=None, password=None, tags=None)

Get an existing User resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the user.

  • password (pulumi.Input[str]) – The password of the user. The value of this argument is plain-text so make sure to secure where this is defined.

  • tags (pulumi.Input[list]) – Which permission model to apply to the user. Valid options are: management, policymaker, monitoring, and administrator.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_rabbitmq.VHost(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)

The .VHost resource creates and manages a vhost.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the vhost.

name = None

The name of the vhost.

static get(resource_name, id, opts=None, name=None)

Get an existing VHost resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the vhost.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str