RabbitMQ v3.2.0, Nov 11 21

rabbitmq.Policy

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

Example Usage

using Pulumi;
using RabbitMQ = Pulumi.RabbitMQ;

class MyStack : Stack
{
    public MyStack()
    {
        var testVHost = new RabbitMQ.VHost("testVHost", new RabbitMQ.VHostArgs
        {
        });
        var guest = new RabbitMQ.Permissions("guest", new RabbitMQ.PermissionsArgs
        {
            Permissions = new RabbitMQ.Inputs.PermissionsPermissionsArgs
            {
                Configure = ".*",
                Read = ".*",
                Write = ".*",
            },
            User = "guest",
            Vhost = testVHost.Name,
        });
        var testPolicy = new RabbitMQ.Policy("testPolicy", new RabbitMQ.PolicyArgs
        {
            Policy = new RabbitMQ.Inputs.PolicyPolicyArgs
            {
                ApplyTo = "all",
                Definition = 
                {
                    { "ha-mode", "all" },
                },
                Pattern = ".*",
                Priority = 0,
            },
            Vhost = guest.Vhost,
        });
    }

}

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
		}
		guest, err := rabbitmq.NewPermissions(ctx, "guest", &rabbitmq.PermissionsArgs{
			Permissions: &PermissionsPermissionsArgs{
				Configure: pulumi.String(".*"),
				Read:      pulumi.String(".*"),
				Write:     pulumi.String(".*"),
			},
			User:  pulumi.String("guest"),
			Vhost: testVHost.Name,
		})
		if err != nil {
			return err
		}
		_, err = rabbitmq.NewPolicy(ctx, "testPolicy", &rabbitmq.PolicyArgs{
			Policy: &PolicyPolicyArgs{
				ApplyTo: pulumi.String("all"),
				Definition: pulumi.AnyMap{
					"ha-mode": pulumi.Any("all"),
				},
				Pattern:  pulumi.String(".*"),
				Priority: pulumi.Int(0),
			},
			Vhost: guest.Vhost,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rabbitmq as rabbitmq

test_v_host = rabbitmq.VHost("testVHost")
guest = rabbitmq.Permissions("guest",
    permissions=rabbitmq.PermissionsPermissionsArgs(
        configure=".*",
        read=".*",
        write=".*",
    ),
    user="guest",
    vhost=test_v_host.name)
test_policy = rabbitmq.Policy("testPolicy",
    policy=rabbitmq.PolicyPolicyArgs(
        apply_to="all",
        definition={
            "ha-mode": "all",
        },
        pattern=".*",
        priority=0,
    ),
    vhost=guest.vhost)

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

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

Coming soon!

Create Policy Resource

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           name: Optional[str] = None,
           policy: Optional[PolicyPolicyArgs] = None,
           vhost: Optional[str] = None)
@overload
def Policy(resource_name: str,
           args: PolicyArgs,
           opts: Optional[ResourceOptions] = 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.

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

name string: The unique name of the resource.
args PolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

The Policy resource accepts the following input properties:

PolicyBlock Pulumi.RabbitMQ.Inputs.PolicyPolicyArgs: The settings of the policy. The structure is described below.
Vhost string: The vhost to create the resource in.
Name string: The name of the policy.

Policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
Vhost string: The vhost to create the resource in.
Name string: The name of the policy.

policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost String: The vhost to create the resource in.
name String: The name of the policy.

policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost string: The vhost to create the resource in.
name string: The name of the policy.

policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost str: The vhost to create the resource in.
name str: The name of the policy.

policy Property Map: The settings of the policy. The structure is described below.
vhost String: The vhost to create the resource in.
name 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)

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:

Name string: The name of the policy.
PolicyBlock Pulumi.RabbitMQ.Inputs.PolicyPolicyArgs: The settings of the policy. The structure is described below.
Vhost string: The vhost to create the resource in.

Name string: The name of the policy.
Policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
Vhost string: The vhost to create the resource in.

name String: The name of the policy.
policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost String: The vhost to create the resource in.

name string: The name of the policy.
policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost string: The vhost to create the resource in.

name str: The name of the policy.
policy PolicyPolicyArgs: The settings of the policy. The structure is described below.
vhost str: The vhost to create the resource in.

name String: The name of the policy.
policy Property Map: The settings of the policy. The structure is described below.
vhost String: The vhost to create the resource in.

Supporting Types

PolicyPolicy

ApplyTo string: Can either be "exchanges", "queues", or "all".
Definition Dictionary<string, object>: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
Pattern string: A pattern to match an exchange or queue name.
Priority int: The policy with the greater priority is applied first.

ApplyTo string: Can either be "exchanges", "queues", or "all".
Definition map[string]interface{}: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
Pattern string: A pattern to match an exchange or queue name.
Priority int: The policy with the greater priority is applied first.

applyTo String: Can either be "exchanges", "queues", or "all".
definition Map<String,Object>: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern String: A pattern to match an exchange or queue name.
priority Integer: The policy with the greater priority is applied first.

applyTo string: Can either be "exchanges", "queues", or "all".
definition {[key: string]: any}: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern string: A pattern to match an exchange or queue name.
priority number: The policy with the greater priority is applied first.

apply_to str: Can either be "exchanges", "queues", or "all".
definition Mapping[str, Any]: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern str: A pattern to match an exchange or queue name.
priority int: The policy with the greater priority is applied first.

applyTo String: Can either be "exchanges", "queues", or "all".
definition Map<Any>: Key/value pairs of the policy definition. See the RabbitMQ documentation for definition references and examples.
pattern String: A pattern to match an exchange or queue name.
priority 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

Package Details

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