Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rabbitmq Provider
  3. API Docs
  4. Policy
RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-rabbitmq

rabbitmq.Policy

Explore with Pulumi AI

RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-rabbitmq

The rabbitmq.Policy resource creates and manages policies for exchanges and queues.

Example Usage

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

const test = new rabbitmq.VHost("test", {name: "test"});
const guest = new rabbitmq.Permissions("guest", {
    user: "guest",
    vhost: test.name,
    permissions: {
        configure: ".*",
        write: ".*",
        read: ".*",
    },
});
const testPolicy = new rabbitmq.Policy("test", {
    name: "test",
    vhost: guest.vhost,
    policy: {
        pattern: ".*",
        priority: 0,
        applyTo: "all",
        definition: {
            "ha-mode": "all",
        },
    },
});
Copy
import pulumi
import pulumi_rabbitmq as rabbitmq

test = rabbitmq.VHost("test", name="test")
guest = rabbitmq.Permissions("guest",
    user="guest",
    vhost=test.name,
    permissions={
        "configure": ".*",
        "write": ".*",
        "read": ".*",
    })
test_policy = rabbitmq.Policy("test",
    name="test",
    vhost=guest.vhost,
    policy={
        "pattern": ".*",
        "priority": 0,
        "apply_to": "all",
        "definition": {
            "ha-mode": "all",
        },
    })
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
		}
		guest, err := rabbitmq.NewPermissions(ctx, "guest", &rabbitmq.PermissionsArgs{
			User:  pulumi.String("guest"),
			Vhost: test.Name,
			Permissions: &rabbitmq.PermissionsPermissionsArgs{
				Configure: pulumi.String(".*"),
				Write:     pulumi.String(".*"),
				Read:      pulumi.String(".*"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rabbitmq.NewPolicy(ctx, "test", &rabbitmq.PolicyArgs{
			Name:  pulumi.String("test"),
			Vhost: guest.Vhost,
			Policy: &rabbitmq.PolicyPolicyArgs{
				Pattern:  pulumi.String(".*"),
				Priority: pulumi.Int(0),
				ApplyTo:  pulumi.String("all"),
				Definition: pulumi.StringMap{
					"ha-mode": pulumi.String("all"),
				},
			},
		})
		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 guest = new RabbitMQ.Permissions("guest", new()
    {
        User = "guest",
        Vhost = test.Name,
        PermissionDetails = new RabbitMQ.Inputs.PermissionsPermissionsArgs
        {
            Configure = ".*",
            Write = ".*",
            Read = ".*",
        },
    });

    var testPolicy = new RabbitMQ.Policy("test", new()
    {
        Name = "test",
        Vhost = guest.Vhost,
        PolicyBlock = new RabbitMQ.Inputs.PolicyPolicyArgs
        {
            Pattern = ".*",
            Priority = 0,
            ApplyTo = "all",
            Definition = 
            {
                { "ha-mode", "all" },
            },
        },
    });

});
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.Permissions;
import com.pulumi.rabbitmq.PermissionsArgs;
import com.pulumi.rabbitmq.inputs.PermissionsPermissionsArgs;
import com.pulumi.rabbitmq.Policy;
import com.pulumi.rabbitmq.PolicyArgs;
import com.pulumi.rabbitmq.inputs.PolicyPolicyArgs;
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 guest = new Permissions("guest", PermissionsArgs.builder()
            .user("guest")
            .vhost(test.name())
            .permissions(PermissionsPermissionsArgs.builder()
                .configure(".*")
                .write(".*")
                .read(".*")
                .build())
            .build());

        var testPolicy = new Policy("testPolicy", PolicyArgs.builder()
            .name("test")
            .vhost(guest.vhost())
            .policy(PolicyPolicyArgs.builder()
                .pattern(".*")
                .priority(0)
                .applyTo("all")
                .definition(Map.of("ha-mode", "all"))
                .build())
            .build());

    }
}
Copy
resources:
  test:
    type: rabbitmq:VHost
    properties:
      name: test
  guest:
    type: rabbitmq:Permissions
    properties:
      user: guest
      vhost: ${test.name}
      permissions:
        configure: .*
        write: .*
        read: .*
  testPolicy:
    type: rabbitmq:Policy
    name: test
    properties:
      name: test
      vhost: ${guest.vhost}
      policy:
        pattern: .*
        priority: 0
        applyTo: all
        definition:
          ha-mode: all
Copy

Create Policy Resource

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

Constructor syntax

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

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           policy: Optional[PolicyPolicyArgs] = None,
           vhost: Optional[str] = None,
           name: Optional[str] = None)
func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)

type: rabbitmq:Policy
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. PolicyArgs
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. PolicyArgs
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. PolicyArgs
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. PolicyArgs
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. PolicyArgs
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 policyResource = new RabbitMQ.Policy("policyResource", new()
{
    PolicyBlock = new RabbitMQ.Inputs.PolicyPolicyArgs
    {
        ApplyTo = "string",
        Definition = 
        {
            { "string", "string" },
        },
        Pattern = "string",
        Priority = 0,
    },
    Vhost = "string",
    Name = "string",
});
Copy
example, err := rabbitmq.NewPolicy(ctx, "policyResource", &rabbitmq.PolicyArgs{
	Policy: &rabbitmq.PolicyPolicyArgs{
		ApplyTo: pulumi.String("string"),
		Definition: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Pattern:  pulumi.String("string"),
		Priority: pulumi.Int(0),
	},
	Vhost: pulumi.String("string"),
	Name:  pulumi.String("string"),
})
Copy
var policyResource = new Policy("policyResource", PolicyArgs.builder()
    .policy(PolicyPolicyArgs.builder()
        .applyTo("string")
        .definition(Map.of("string", "string"))
        .pattern("string")
        .priority(0)
        .build())
    .vhost("string")
    .name("string")
    .build());
Copy
policy_resource = rabbitmq.Policy("policyResource",
    policy={
        "apply_to": "string",
        "definition": {
            "string": "string",
        },
        "pattern": "string",
        "priority": 0,
    },
    vhost="string",
    name="string")
Copy
const policyResource = new rabbitmq.Policy("policyResource", {
    policy: {
        applyTo: "string",
        definition: {
            string: "string",
        },
        pattern: "string",
        priority: 0,
    },
    vhost: "string",
    name: "string",
});
Copy
type: rabbitmq:Policy
properties:
    name: string
    policy:
        applyTo: string
        definition:
            string: string
        pattern: string
        priority: 0
    vhost: string
Copy

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

PolicyBlock This property is required. Pulumi.RabbitMQ.Inputs.PolicyPolicy
The settings of the policy. The structure is described below.
Vhost
This property is required.
Changes to this property will trigger replacement.
string
The vhost to create the resource in.
Name Changes to this property will trigger replacement. string
The name of the policy.
Policy This property is required. PolicyPolicyArgs
The settings of the policy. The structure is described below.
Vhost
This property is required.
Changes to this property will trigger replacement.
string
The vhost to create the resource in.
Name Changes to this property will trigger replacement. string
The name of the policy.
policy This property is required. PolicyPolicy
The settings of the policy. The structure is described below.
vhost
This property is required.
Changes to this property will trigger replacement.
String
The vhost to create the resource in.
name Changes to this property will trigger replacement. String
The name of the policy.
policy This property is required. PolicyPolicy
The settings of the policy. The structure is described below.
vhost
This property is required.
Changes to this property will trigger replacement.
string
The vhost to create the resource in.
name Changes to this property will trigger replacement. string
The name of the policy.
policy This property is required. PolicyPolicyArgs
The settings of the policy. The structure is described below.
vhost
This property is required.
Changes to this property will trigger replacement.
str
The vhost to create the resource in.
name Changes to this property will trigger replacement. str
The name of the policy.
policy This property is required. Property Map
The settings of the policy. The structure is described below.
vhost
This property is required.
Changes to this property will trigger replacement.
String
The vhost to create the resource in.
name Changes to this property will trigger replacement. String
The name of the policy.

Outputs

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

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

Supporting Types

PolicyPolicy
, PolicyPolicyArgs

ApplyTo This property is required. string
Can either be "exchanges", "queues", or "all".
Definition This property is required. Dictionary<string, string>
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
Pattern This property is required. string
A pattern to match an exchange or queue name.
Priority This property is required. int
The policy with the greater priority is applied first.
ApplyTo This property is required. string
Can either be "exchanges", "queues", or "all".
Definition This property is required. map[string]string
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
Pattern This property is required. string
A pattern to match an exchange or queue name.
Priority This property is required. int
The policy with the greater priority is applied first.
applyTo This property is required. String
Can either be "exchanges", "queues", or "all".
definition This property is required. Map<String,String>
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern This property is required. String
A pattern to match an exchange or queue name.
priority This property is required. Integer
The policy with the greater priority is applied first.
applyTo This property is required. string
Can either be "exchanges", "queues", or "all".
definition This property is required. {[key: string]: string}
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern This property is required. string
A pattern to match an exchange or queue name.
priority This property is required. number
The policy with the greater priority is applied first.
apply_to This property is required. str
Can either be "exchanges", "queues", or "all".
definition This property is required. Mapping[str, str]
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern This property is required. str
A pattern to match an exchange or queue name.
priority This property is required. int
The policy with the greater priority is applied first.
applyTo This property is required. String
Can either be "exchanges", "queues", or "all".
definition This property is required. Map<String>
Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern This property is required. String
A pattern to match an exchange or queue name.
priority This property is required. Number
The policy with the greater priority is applied first.

Import

Policies can be imported using the id which is composed of name@vhost.

E.g.

$ pulumi import rabbitmq:index/policy:Policy test name@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.
RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-rabbitmq