Docs Packages
  1. Packages
  2. RabbitMQ
  3. API Docs
  4. TopicPermissions
RabbitMQ v3.3.2 published on Thursday, Mar 21, 2024 by Pulumi
pulumi/pulumi-rabbitmq

rabbitmq.TopicPermissions

Explore with Pulumi AI

rabbitmq logo
RabbitMQ v3.3.2 published on Thursday, Mar 21, 2024 by Pulumi
pulumi/pulumi-rabbitmq

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

    Example Usage

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

const testVHost = new rabbitmq.VHost("testVHost", {});
const testUser = new rabbitmq.User("testUser", {
    password: "foobar",
    tags: ["administrator"],
});
const testTopicPermissions = new rabbitmq.TopicPermissions("testTopicPermissions", {
    permissions: [{
        exchange: "amq.topic",
        read: ".*",
        write: ".*",
    }],
    user: testUser.name,
    vhost: testVHost.name,
});

    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=[rabbitmq.TopicPermissionsPermissionArgs(
        exchange="amq.topic",
        read=".*",
        write=".*",
    )],
    user=test_user.name,
    vhost=test_v_host.name)

    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 {
		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.NewTopicPermissions(ctx, "testTopicPermissions", &rabbitmq.TopicPermissionsArgs{
			Permissions: rabbitmq.TopicPermissionsPermissionArray{
				&rabbitmq.TopicPermissionsPermissionArgs{
					Exchange: pulumi.String("amq.topic"),
					Read:     pulumi.String(".*"),
					Write:    pulumi.String(".*"),
				},
			},
			User:  testUser.Name,
			Vhost: testVHost.Name,
		})
		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 testVHost = new RabbitMQ.VHost("testVHost");

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

    var testTopicPermissions = new RabbitMQ.TopicPermissions("testTopicPermissions", new()
    {
        Permissions = new[]
        {
            new RabbitMQ.Inputs.TopicPermissionsPermissionArgs
            {
                Exchange = "amq.topic",
                Read = ".*",
                Write = ".*",
            },
        },
        User = testUser.Name,
        Vhost = testVHost.Name,
    });

});

    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.User;
import com.pulumi.rabbitmq.UserArgs;
import com.pulumi.rabbitmq.TopicPermissions;
import com.pulumi.rabbitmq.TopicPermissionsArgs;
import com.pulumi.rabbitmq.inputs.TopicPermissionsPermissionArgs;
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 testVHost = new VHost("testVHost");

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

        var testTopicPermissions = new TopicPermissions("testTopicPermissions", TopicPermissionsArgs.builder()        
            .permissions(TopicPermissionsPermissionArgs.builder()
                .exchange("amq.topic")
                .read(".*")
                .write(".*")
                .build())
            .user(testUser.name())
            .vhost(testVHost.name())
            .build());

    }
}

    resources:
  testVHost:
    type: rabbitmq:VHost
  testUser:
    type: rabbitmq:User
    properties:
      password: foobar
      tags:
        - administrator
  testTopicPermissions:
    type: rabbitmq:TopicPermissions
    properties:
      permissions:
        - exchange: amq.topic
          read: .*
          write: .*
      user: ${testUser.name}
      vhost: ${testVHost.name}

    Create TopicPermissions Resource

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

    Constructor syntax

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

@overload
def TopicPermissions(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     permissions: Optional[Sequence[TopicPermissionsPermissionArgs]] = None,
                     user: Optional[str] = None,
                     vhost: Optional[str] = None)
    func NewTopicPermissions(ctx *Context, name string, args TopicPermissionsArgs, opts ...ResourceOption) (*TopicPermissions, error)
    public TopicPermissions(string name, TopicPermissionsArgs args, CustomResourceOptions? opts = null)
    public TopicPermissions(String name, TopicPermissionsArgs args)
public TopicPermissions(String name, TopicPermissionsArgs args, CustomResourceOptions options)

    type: rabbitmq:TopicPermissions
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 TopicPermissionsArgs
    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 TopicPermissionsArgs
    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 TopicPermissionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TopicPermissionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TopicPermissionsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var topicPermissionsResource = new RabbitMQ.TopicPermissions("topicPermissionsResource", new()
{
    Permissions = new[]
    {
        new RabbitMQ.Inputs.TopicPermissionsPermissionArgs
        {
            Exchange = "string",
            Read = "string",
            Write = "string",
        },
    },
    User = "string",
    Vhost = "string",
});

    example, err := rabbitmq.NewTopicPermissions(ctx, "topicPermissionsResource", &rabbitmq.TopicPermissionsArgs{
	Permissions: rabbitmq.TopicPermissionsPermissionArray{
		&rabbitmq.TopicPermissionsPermissionArgs{
			Exchange: pulumi.String("string"),
			Read:     pulumi.String("string"),
			Write:    pulumi.String("string"),
		},
	},
	User:  pulumi.String("string"),
	Vhost: pulumi.String("string"),
})

    var topicPermissionsResource = new TopicPermissions("topicPermissionsResource", TopicPermissionsArgs.builder()        
    .permissions(TopicPermissionsPermissionArgs.builder()
        .exchange("string")
        .read("string")
        .write("string")
        .build())
    .user("string")
    .vhost("string")
    .build());

    topic_permissions_resource = rabbitmq.TopicPermissions("topicPermissionsResource",
    permissions=[rabbitmq.TopicPermissionsPermissionArgs(
        exchange="string",
        read="string",
        write="string",
    )],
    user="string",
    vhost="string")

    const topicPermissionsResource = new rabbitmq.TopicPermissions("topicPermissionsResource", {
    permissions: [{
        exchange: "string",
        read: "string",
        write: "string",
    }],
    user: "string",
    vhost: "string",
});

    type: rabbitmq:TopicPermissions
properties:
    permissions:
        - exchange: string
          read: string
          write: string
    user: string
    vhost: string

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

    Permissions List<Pulumi.RabbitMQ.Inputs.TopicPermissionsPermission>
    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 []TopicPermissionsPermissionArgs
    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 List<TopicPermissionsPermission>
    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 TopicPermissionsPermission[]
    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 Sequence[TopicPermissionsPermissionArgs]
    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 List<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 TopicPermissions 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 TopicPermissions Resource

    Get an existing TopicPermissions 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?: TopicPermissionsState, opts?: CustomResourceOptions): TopicPermissions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        permissions: Optional[Sequence[TopicPermissionsPermissionArgs]] = None,
        user: Optional[str] = None,
        vhost: Optional[str] = None) -> TopicPermissions
    func GetTopicPermissions(ctx *Context, name string, id IDInput, state *TopicPermissionsState, opts ...ResourceOption) (*TopicPermissions, error)
    public static TopicPermissions Get(string name, Input<string> id, TopicPermissionsState? state, CustomResourceOptions? opts = null)
    public static TopicPermissions get(String name, Output<String> id, TopicPermissionsState 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:
    Permissions List<Pulumi.RabbitMQ.Inputs.TopicPermissionsPermission>
    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 []TopicPermissionsPermissionArgs
    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 List<TopicPermissionsPermission>
    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 TopicPermissionsPermission[]
    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 Sequence[TopicPermissionsPermissionArgs]
    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 List<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

    TopicPermissionsPermission, TopicPermissionsPermissionArgs

    Exchange string
    The exchange to set the permissions for.
    Read string
    The "read" ACL.
    Write string
    The "write" ACL.
    Exchange string
    The exchange to set the permissions for.
    Read string
    The "read" ACL.
    Write string
    The "write" ACL.
    exchange String
    The exchange to set the permissions for.
    read String
    The "read" ACL.
    write String
    The "write" ACL.
    exchange string
    The exchange to set the permissions for.
    read string
    The "read" ACL.
    write string
    The "write" ACL.
    exchange str
    The exchange to set the permissions for.
    read str
    The "read" ACL.
    write str
    The "write" ACL.
    exchange String
    The exchange to set the permissions for.
    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/topicPermissions:TopicPermissions 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.2 published on Thursday, Mar 21, 2024 by Pulumi
    pulumi/pulumi-rabbitmq