1. Packages
  2. Rabbitmq Provider
  3. API Docs
  4. Permissions
RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi

rabbitmq.Permissions

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as rabbitmq from "@pulumi/rabbitmq";

const test = new rabbitmq.VHost("test", {name: "test"});
const testUser = new rabbitmq.User("test", {
    name: "mctest",
    password: "foobar",
    tags: ["administrator"],
});
const testPermissions = new rabbitmq.Permissions("test", {
    user: testUser.name,
    vhost: test.name,
    permissions: {
        configure: ".*",
        write: ".*",
        read: ".*",
    },
});
Copy
import pulumi
import pulumi_rabbitmq as rabbitmq

test = rabbitmq.VHost("test", name="test")
test_user = rabbitmq.User("test",
    name="mctest",
    password="foobar",
    tags=["administrator"])
test_permissions = rabbitmq.Permissions("test",
    user=test_user.name,
    vhost=test.name,
    permissions={
        "configure": ".*",
        "write": ".*",
        "read": ".*",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-rabbitmq/sdk/v3/go/rabbitmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := rabbitmq.NewVHost(ctx, "test", &rabbitmq.VHostArgs{
			Name: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		testUser, err := rabbitmq.NewUser(ctx, "test", &rabbitmq.UserArgs{
			Name:     pulumi.String("mctest"),
			Password: pulumi.String("foobar"),
			Tags: pulumi.StringArray{
				pulumi.String("administrator"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rabbitmq.NewPermissions(ctx, "test", &rabbitmq.PermissionsArgs{
			User:  testUser.Name,
			Vhost: test.Name,
			Permissions: &rabbitmq.PermissionsPermissionsArgs{
				Configure: pulumi.String(".*"),
				Write:     pulumi.String(".*"),
				Read:      pulumi.String(".*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using RabbitMQ = Pulumi.RabbitMQ;

return await Deployment.RunAsync(() => 
{
    var test = new RabbitMQ.VHost("test", new()
    {
        Name = "test",
    });

    var testUser = new RabbitMQ.User("test", new()
    {
        Name = "mctest",
        Password = "foobar",
        Tags = new[]
        {
            "administrator",
        },
    });

    var testPermissions = new RabbitMQ.Permissions("test", new()
    {
        User = testUser.Name,
        Vhost = test.Name,
        PermissionDetails = new RabbitMQ.Inputs.PermissionsPermissionsArgs
        {
            Configure = ".*",
            Write = ".*",
            Read = ".*",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rabbitmq.VHost;
import com.pulumi.rabbitmq.VHostArgs;
import com.pulumi.rabbitmq.User;
import com.pulumi.rabbitmq.UserArgs;
import com.pulumi.rabbitmq.Permissions;
import com.pulumi.rabbitmq.PermissionsArgs;
import com.pulumi.rabbitmq.inputs.PermissionsPermissionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new VHost("test", VHostArgs.builder()
            .name("test")
            .build());

        var testUser = new User("testUser", UserArgs.builder()
            .name("mctest")
            .password("foobar")
            .tags("administrator")
            .build());

        var testPermissions = new Permissions("testPermissions", PermissionsArgs.builder()
            .user(testUser.name())
            .vhost(test.name())
            .permissions(PermissionsPermissionsArgs.builder()
                .configure(".*")
                .write(".*")
                .read(".*")
                .build())
            .build());

    }
}
Copy
resources:
  test:
    type: rabbitmq:VHost
    properties:
      name: test
  testUser:
    type: rabbitmq:User
    name: test
    properties:
      name: mctest
      password: foobar
      tags:
        - administrator
  testPermissions:
    type: rabbitmq:Permissions
    name: test
    properties:
      user: ${testUser.name}
      vhost: ${test.name}
      permissions:
        configure: .*
        write: .*
        read: .*
Copy

Create Permissions Resource

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

Constructor syntax

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

@overload
def Permissions(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                permissions: Optional[PermissionsPermissionsArgs] = None,
                user: Optional[str] = None,
                vhost: Optional[str] = None)
func NewPermissions(ctx *Context, name string, args PermissionsArgs, opts ...ResourceOption) (*Permissions, error)
public Permissions(string name, PermissionsArgs args, CustomResourceOptions? opts = null)
public Permissions(String name, PermissionsArgs args)
public Permissions(String name, PermissionsArgs args, CustomResourceOptions options)
type: rabbitmq:Permissions
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. PermissionsArgs
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. PermissionsArgs
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. PermissionsArgs
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. PermissionsArgs
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. PermissionsArgs
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 permissionsResource = new RabbitMQ.Permissions("permissionsResource", new()
{
    PermissionDetails = new RabbitMQ.Inputs.PermissionsPermissionsArgs
    {
        Configure = "string",
        Read = "string",
        Write = "string",
    },
    User = "string",
    Vhost = "string",
});
Copy
example, err := rabbitmq.NewPermissions(ctx, "permissionsResource", &rabbitmq.PermissionsArgs{
	Permissions: &rabbitmq.PermissionsPermissionsArgs{
		Configure: pulumi.String("string"),
		Read:      pulumi.String("string"),
		Write:     pulumi.String("string"),
	},
	User:  pulumi.String("string"),
	Vhost: pulumi.String("string"),
})
Copy
var permissionsResource = new Permissions("permissionsResource", PermissionsArgs.builder()
    .permissions(PermissionsPermissionsArgs.builder()
        .configure("string")
        .read("string")
        .write("string")
        .build())
    .user("string")
    .vhost("string")
    .build());
Copy
permissions_resource = rabbitmq.Permissions("permissionsResource",
    permissions={
        "configure": "string",
        "read": "string",
        "write": "string",
    },
    user="string",
    vhost="string")
Copy
const permissionsResource = new rabbitmq.Permissions("permissionsResource", {
    permissions: {
        configure: "string",
        read: "string",
        write: "string",
    },
    user: "string",
    vhost: "string",
});
Copy
type: rabbitmq:Permissions
properties:
    permissions:
        configure: string
        read: string
        write: string
    user: string
    vhost: string
Copy

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

PermissionDetails This property is required. Pulumi.RabbitMQ.Inputs.PermissionsPermissions
The settings of the permissions. The structure is described below.
User
This property is required.
Changes to this property will trigger replacement.
string
The user to apply the permissions to.
Vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
Permissions This property is required. PermissionsPermissionsArgs
The settings of the permissions. The structure is described below.
User
This property is required.
Changes to this property will trigger replacement.
string
The user to apply the permissions to.
Vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
permissions This property is required. PermissionsPermissions
The settings of the permissions. The structure is described below.
user
This property is required.
Changes to this property will trigger replacement.
String
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. String
The vhost to create the resource in.
permissions This property is required. PermissionsPermissions
The settings of the permissions. The structure is described below.
user
This property is required.
Changes to this property will trigger replacement.
string
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
permissions This property is required. PermissionsPermissionsArgs
The settings of the permissions. The structure is described below.
user
This property is required.
Changes to this property will trigger replacement.
str
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. str
The vhost to create the resource in.
permissions This property is required. Property Map
The settings of the permissions. The structure is described below.
user
This property is required.
Changes to this property will trigger replacement.
String
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. String
The vhost to create the resource in.

Outputs

All input properties are implicitly available as output properties. Additionally, the Permissions 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 Permissions Resource

Get an existing Permissions 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?: PermissionsState, opts?: CustomResourceOptions): Permissions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        permissions: Optional[PermissionsPermissionsArgs] = None,
        user: Optional[str] = None,
        vhost: Optional[str] = None) -> Permissions
func GetPermissions(ctx *Context, name string, id IDInput, state *PermissionsState, opts ...ResourceOption) (*Permissions, error)
public static Permissions Get(string name, Input<string> id, PermissionsState? state, CustomResourceOptions? opts = null)
public static Permissions get(String name, Output<String> id, PermissionsState state, CustomResourceOptions options)
resources:  _:    type: rabbitmq:Permissions    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:
PermissionDetails Pulumi.RabbitMQ.Inputs.PermissionsPermissions
The settings of the permissions. The structure is described below.
User Changes to this property will trigger replacement. string
The user to apply the permissions to.
Vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
Permissions PermissionsPermissionsArgs
The settings of the permissions. The structure is described below.
User Changes to this property will trigger replacement. string
The user to apply the permissions to.
Vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
permissions PermissionsPermissions
The settings of the permissions. The structure is described below.
user Changes to this property will trigger replacement. String
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. String
The vhost to create the resource in.
permissions PermissionsPermissions
The settings of the permissions. The structure is described below.
user Changes to this property will trigger replacement. string
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. string
The vhost to create the resource in.
permissions PermissionsPermissionsArgs
The settings of the permissions. The structure is described below.
user Changes to this property will trigger replacement. str
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. str
The vhost to create the resource in.
permissions Property Map
The settings of the permissions. The structure is described below.
user Changes to this property will trigger replacement. String
The user to apply the permissions to.
vhost Changes to this property will trigger replacement. String
The vhost to create the resource in.

Supporting Types

PermissionsPermissions
, PermissionsPermissionsArgs

Configure This property is required. string
The "configure" ACL.
Read This property is required. string
The "read" ACL.
Write This property is required. string
The "write" ACL.
Configure This property is required. string
The "configure" ACL.
Read This property is required. string
The "read" ACL.
Write This property is required. string
The "write" ACL.
configure This property is required. String
The "configure" ACL.
read This property is required. String
The "read" ACL.
write This property is required. String
The "write" ACL.
configure This property is required. string
The "configure" ACL.
read This property is required. string
The "read" ACL.
write This property is required. string
The "write" ACL.
configure This property is required. str
The "configure" ACL.
read This property is required. str
The "read" ACL.
write This property is required. str
The "write" ACL.
configure This property is required. String
The "configure" ACL.
read This property is required. String
The "read" ACL.
write This property is required. String
The "write" ACL.

Import

Permissions can be imported using the id which is composed of user@vhost.

E.g.

$ pulumi import rabbitmq:index/permissions:Permissions test user@vhost
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
RabbitMQ pulumi/pulumi-rabbitmq
License
Apache-2.0
Notes
This Pulumi package is based on the rabbitmq Terraform Provider.