Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Permissions

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

Example Usage

using Pulumi;
using RabbitMQ = Pulumi.RabbitMQ;

class MyStack : Stack
{
    public MyStack()
    {
        var testVHost = new RabbitMQ.VHost("testVHost", new RabbitMQ.VHostArgs
        {
        });
        var testUser = new RabbitMQ.User("testUser", new RabbitMQ.UserArgs
        {
            Password = "foobar",
            Tags = 
            {
                "administrator",
            },
        });
        var testPermissions = new RabbitMQ.Permissions("testPermissions", new RabbitMQ.PermissionsArgs
        {
            Permissions = new RabbitMQ.Inputs.PermissionsPermissionsArgs
            {
                Configure = ".*",
                Read = ".*",
                Write = ".*",
            },
            User = testUser.Name,
            Vhost = testVHost.Name,
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        testVHost, err := rabbitmq.NewVHost(ctx, "testVHost", nil)
        if err != nil {
            return err
        }
        testUser, err := rabbitmq.NewUser(ctx, "testUser", &rabbitmq.UserArgs{
            Password: pulumi.String("foobar"),
            Tags: pulumi.StringArray{
                pulumi.String("administrator"),
            },
        })
        if err != nil {
            return err
        }
        _, err = rabbitmq.NewPermissions(ctx, "testPermissions", &rabbitmq.PermissionsArgs{
            Permissions: &rabbitmq.PermissionsPermissionsArgs{
                Configure: pulumi.String(".*"),
                Read:      pulumi.String(".*"),
                Write:     pulumi.String(".*"),
            },
            User:  testUser.Name,
            Vhost: testVHost.Name,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
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=rabbitmq.PermissionsPermissionsArgs(
        configure=".*",
        read=".*",
        write=".*",
    ),
    user=test_user.name,
    vhost=test_v_host.name)
import * as pulumi from "@pulumi/pulumi";
import * as rabbitmq from "@pulumi/rabbitmq";

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

Create a Permissions Resource

new Permissions(name: string, args: PermissionsArgs, opts?: CustomResourceOptions);
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)
name string
The unique name of the resource.
args PermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PermissionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Permissions Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Permissions resource accepts the following input properties:

PermissionDetails Pulumi.RabbitMQ.Inputs.PermissionsPermissionsArgs

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

User string

The user to apply the permissions to.

Vhost string

The vhost to create the resource in.

Permissions PermissionsPermissions

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

User string

The user to apply the permissions to.

Vhost string

The vhost to create the resource in.

permissions PermissionsPermissions

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

user string

The user to apply the permissions to.

vhost string

The vhost to create the resource in.

permissions PermissionsPermissionsArgs

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

user str

The user to apply the permissions to.

vhost str

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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)
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.

The following state arguments are supported:

PermissionDetails Pulumi.RabbitMQ.Inputs.PermissionsPermissionsArgs

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

User string

The user to apply the permissions to.

Vhost string

The vhost to create the resource in.

Permissions PermissionsPermissions

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

User string

The user to apply the permissions to.

Vhost string

The vhost to create the resource in.

permissions PermissionsPermissions

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

user string

The user to apply the permissions to.

vhost string

The vhost to create the resource in.

permissions PermissionsPermissionsArgs

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

user str

The user to apply the permissions to.

vhost str

The vhost to create the resource in.

Supporting Types

PermissionsPermissions

Configure string

The “configure” ACL.

Read string

The “read” ACL.

Write string

The “write” ACL.

Configure string

The “configure” ACL.

Read string

The “read” ACL.

Write string

The “write” ACL.

configure string

The “configure” ACL.

read string

The “read” ACL.

write string

The “write” ACL.

configure str

The “configure” ACL.

read str

The “read” ACL.

write str

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

Package Details

Repository
https://github.com/pulumi/pulumi-rabbitmq
License
Apache-2.0
Notes
This Pulumi package is based on the rabbitmq Terraform Provider.