1. Packages
  2. RabbitMQ
  3. API Docs
  4. Permissions
RabbitMQ v3.3.3 published on Friday, May 24, 2024 by Pulumi

rabbitmq.Permissions

Explore with Pulumi AI

rabbitmq logo
RabbitMQ v3.3.3 published on Friday, May 24, 2024 by Pulumi

    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: ".*",
        },
    });
    
    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=rabbitmq.PermissionsPermissionsArgs(
            configure=".*",
            write=".*",
            read=".*",
        ))
    
    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
    	})
    }
    
    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 = ".*",
            },
        });
    
    });
    
    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());
    
        }
    }
    
    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: .*
    

    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 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.
    args 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 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.
    name String
    The unique name of the resource.
    args 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",
    });
    
    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"),
    })
    
    var permissionsResource = new Permissions("permissionsResource", PermissionsArgs.builder()
        .permissions(PermissionsPermissionsArgs.builder()
            .configure("string")
            .read("string")
            .write("string")
            .build())
        .user("string")
        .vhost("string")
        .build());
    
    permissions_resource = rabbitmq.Permissions("permissionsResource",
        permissions=rabbitmq.PermissionsPermissionsArgs(
            configure="string",
            read="string",
            write="string",
        ),
        user="string",
        vhost="string")
    
    const permissionsResource = new rabbitmq.Permissions("permissionsResource", {
        permissions: {
            configure: "string",
            read: "string",
            write: "string",
        },
        user: "string",
        vhost: "string",
    });
    
    type: rabbitmq:Permissions
    properties:
        permissions:
            configure: string
            read: string
            write: string
        user: string
        vhost: string
    

    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

    The Permissions resource accepts the following input properties:

    PermissionDetails Pulumi.RabbitMQ.Inputs.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 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.
    permissions Property Map
    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.

    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)
    Resource lookup is not supported in YAML
    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.
    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.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 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.
    permissions Property Map
    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.

    Supporting Types

    PermissionsPermissions, PermissionsPermissionsArgs

    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 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.
    configure String
    The "configure" ACL.
    read String
    The "read" ACL.
    write 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
    

    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.
    rabbitmq logo
    RabbitMQ v3.3.3 published on Friday, May 24, 2024 by Pulumi