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
.Bindingresource creates and manages a binding relationship between a queue an exchange.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") guest = rabbitmq.Permissions("guest", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user="guest", vhost=test_v_host.name) test_exchange = rabbitmq.Exchange("testExchange", settings={ "autoDelete": True, "durable": False, "type": "fanout", }, vhost=guest.vhost) test_queue = rabbitmq.Queue("testQueue", settings={ "autoDelete": False, "durable": True, }, vhost=guest.vhost) test_binding = rabbitmq.Binding("testBinding", destination=test_queue.name, destination_type="queue", routing_key="#", source=test_exchange.name, vhost=test_v_host.name)
- 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: pulumi.Output[dict] = None¶Additional key/value arguments for the binding.
destination: pulumi.Output[str] = None¶The destination queue or exchange.
destination_type: pulumi.Output[str] = None¶The type of destination (queue or exchange).
properties_key: pulumi.Output[str] = None¶A unique key to refer to the binding.
routing_key: pulumi.Output[str] = None¶A routing key for the binding.
source: pulumi.Output[str] = None¶The source exchange.
vhost: pulumi.Output[str] = 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
.Exchangeresource creates and manages an exchange.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") guest = rabbitmq.Permissions("guest", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user="guest", vhost=test_v_host.name) test_exchange = rabbitmq.Exchange("testExchange", settings={ "autoDelete": True, "durable": False, "type": "fanout", }, vhost=guest.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 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]) - Additional key/value settings for the exchange.autoDelete(pulumi.Input[bool]) - Whether the exchange will self-delete when all queues have finished using it.durable(pulumi.Input[bool]) - Whether the exchange survives server restarts. Defaults tofalse.type(pulumi.Input[str]) - The type of exchange.
name: pulumi.Output[str] = None¶The name of the exchange.
settings: pulumi.Output[dict] = None¶The settings of the exchange. The structure is described below.
arguments(dict) - Additional key/value settings for the exchange.autoDelete(bool) - Whether the exchange will self-delete when all queues have finished using it.durable(bool) - Whether the exchange survives server restarts. Defaults tofalse.type(str) - The type of exchange.
vhost: pulumi.Output[str] = 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]) - Additional key/value settings for the exchange.autoDelete(pulumi.Input[bool]) - Whether the exchange will self-delete when all queues have finished using it.durable(pulumi.Input[bool]) - Whether the exchange survives server restarts. Defaults tofalse.type(pulumi.Input[str]) - The type of exchange.
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
.Permissionsresource creates and manages a user’s set of permissions.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") test_user = rabbitmq.User("testUser", password="foobar", tags=["administrator"]) test_permissions = rabbitmq.Permissions("testPermissions", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user=test_user.name, vhost=test_v_host.name)
- 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]) - The “configure” ACL.read(pulumi.Input[str]) - The “read” ACL.write(pulumi.Input[str]) - The “write” ACL.
permissions: pulumi.Output[dict] = None¶The settings of the permissions. The structure is described below.
configure(str) - The “configure” ACL.read(str) - The “read” ACL.write(str) - The “write” ACL.
user: pulumi.Output[str] = None¶The user to apply the permissions to.
vhost: pulumi.Output[str] = 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]) - The “configure” ACL.read(pulumi.Input[str]) - The “read” ACL.write(pulumi.Input[str]) - The “write” ACL.
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
.Policyresource creates and manages policies for exchanges and queues.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") guest = rabbitmq.Permissions("guest", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user="guest", vhost=test_v_host.name) test_policy = rabbitmq.Policy("testPolicy", policy={ "applyTo": "all", "definition": { "ha-mode": "all", }, "pattern": ".*", "priority": 0, }, vhost=guest.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 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]) - Can either be “exchanges”, “queues”, or “all”.definition(pulumi.Input[dict]) - Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.pattern(pulumi.Input[str]) - A pattern to match an exchange or queue name.priority(pulumi.Input[float]) - The policy with the greater priority is applied first.
name: pulumi.Output[str] = None¶The name of the policy.
policy: pulumi.Output[dict] = None¶The settings of the policy. The structure is described below.
applyTo(str) - Can either be “exchanges”, “queues”, or “all”.definition(dict) - Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.pattern(str) - A pattern to match an exchange or queue name.priority(float) - The policy with the greater priority is applied first.
vhost: pulumi.Output[str] = 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]) - Can either be “exchanges”, “queues”, or “all”.definition(pulumi.Input[dict]) - Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.pattern(pulumi.Input[str]) - A pattern to match an exchange or queue name.priority(pulumi.Input[float]) - The policy with the greater priority is applied first.
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
Providerinstance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
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
.Queueresource creates and manages a queue.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") guest = rabbitmq.Permissions("guest", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user="guest", vhost=test_v_host.name) test_queue = rabbitmq.Queue("testQueue", settings={ "autoDelete": True, "durable": False, }, vhost=guest.vhost)
import pulumi import pulumi_rabbitmq as rabbitmq config = pulumi.Config() arguments = config.get("arguments") if arguments is None: arguments = """{ "x-message-ttl": 5000 } """ test_v_host = rabbitmq.VHost("testVHost") guest = rabbitmq.Permissions("guest", permissions={ "configure": ".*", "read": ".*", "write": ".*", }, user="guest", vhost=test_v_host.name) test_queue = rabbitmq.Queue("testQueue", settings={ "argumentsJson": arguments, "autoDelete": True, "durable": False, }, vhost=guest.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 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]) - Additional key/value settings for the queue. All values will be sent to RabbitMQ as a string. If you require non-string values, usearguments_json.argumentsJson(pulumi.Input[str]) - A nested JSON string which contains additional settings for the queue. This is useful for when the arguments contain non-string values.autoDelete(pulumi.Input[bool]) - Whether the queue will self-delete when all consumers have unsubscribed.durable(pulumi.Input[bool]) - Whether the queue survives server restarts. Defaults tofalse.
name: pulumi.Output[str] = None¶The name of the queue.
settings: pulumi.Output[dict] = None¶The settings of the queue. The structure is described below.
arguments(dict) - Additional key/value settings for the queue. All values will be sent to RabbitMQ as a string. If you require non-string values, usearguments_json.argumentsJson(str) - A nested JSON string which contains additional settings for the queue. This is useful for when the arguments contain non-string values.autoDelete(bool) - Whether the queue will self-delete when all consumers have unsubscribed.durable(bool) - Whether the queue survives server restarts. Defaults tofalse.
vhost: pulumi.Output[str] = 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]) - Additional key/value settings for the queue. All values will be sent to RabbitMQ as a string. If you require non-string values, usearguments_json.argumentsJson(pulumi.Input[str]) - A nested JSON string which contains additional settings for the queue. This is useful for when the arguments contain non-string values.autoDelete(pulumi.Input[bool]) - Whether the queue will self-delete when all consumers have unsubscribed.durable(pulumi.Input[bool]) - Whether the queue survives server restarts. Defaults tofalse.
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
.TopicPermissionsresource creates and manages a user’s set of topic permissions.import pulumi import pulumi_rabbitmq as rabbitmq test_v_host = rabbitmq.VHost("testVHost") test_user = rabbitmq.User("testUser", password="foobar", tags=["administrator"]) test_topic_permissions = rabbitmq.TopicPermissions("testTopicPermissions", permissions=[{ "exchange": "amq.topic", "read": ".*", "write": ".*", }], user=test_user.name, vhost=test_v_host.name)
- 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]) - The exchange to set the permissions for.read(pulumi.Input[str]) - The “read” ACL.write(pulumi.Input[str]) - The “write” ACL.
permissions: pulumi.Output[list] = None¶The settings of the permissions. The structure is described below.
exchange(str) - The exchange to set the permissions for.read(str) - The “read” ACL.write(str) - The “write” ACL.
user: pulumi.Output[str] = None¶The user to apply the permissions to.
vhost: pulumi.Output[str] = 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]) - The exchange to set the permissions for.read(pulumi.Input[str]) - The “read” ACL.write(pulumi.Input[str]) - The “write” ACL.
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
.Userresource 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.
import pulumi import pulumi_rabbitmq as rabbitmq test = rabbitmq.User("test", password="foobar", tags=[ "administrator", "management", ])
- 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: pulumi.Output[str] = None¶The name of the user.
password: pulumi.Output[str] = None¶The password of the user. The value of this argument is plain-text so make sure to secure where this is defined.
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
.VHostresource creates and manages a vhost.import pulumi import pulumi_rabbitmq as rabbitmq my_vhost = rabbitmq.VHost("myVhost")
- 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: pulumi.Output[str] = 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