RabbitMQ v3.3.9, Feb 12 25

RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi

rabbitmq.OperatorPolicy

Explore with Pulumi AI

RabbitMQ v3.3.9 published on Wednesday, Feb 12, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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 testOperatorPolicy = new rabbitmq.OperatorPolicy("test", {
    name: "test",
    vhost: guest.vhost,
    policy: {
        pattern: ".*",
        priority: 0,
        applyTo: "queues",
        definition: {
            "message-ttl": "3600000",
            expires: "1800000",
        },
    },
});

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_operator_policy = rabbitmq.OperatorPolicy("test",
    name="test",
    vhost=guest.vhost,
    policy={
        "pattern": ".*",
        "priority": 0,
        "apply_to": "queues",
        "definition": {
            "message-ttl": "3600000",
            "expires": "1800000",
        },
    })

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.NewOperatorPolicy(ctx, "test", &rabbitmq.OperatorPolicyArgs{
			Name:  pulumi.String("test"),
			Vhost: guest.Vhost,
			Policy: &rabbitmq.OperatorPolicyPolicyArgs{
				Pattern:  pulumi.String(".*"),
				Priority: pulumi.Int(0),
				ApplyTo:  pulumi.String("queues"),
				Definition: pulumi.StringMap{
					"message-ttl": pulumi.String("3600000"),
					"expires":     pulumi.String("1800000"),
				},
			},
		})
		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 guest = new RabbitMQ.Permissions("guest", new()
    {
        User = "guest",
        Vhost = test.Name,
        PermissionDetails = new RabbitMQ.Inputs.PermissionsPermissionsArgs
        {
            Configure = ".*",
            Write = ".*",
            Read = ".*",
        },
    });

    var testOperatorPolicy = new RabbitMQ.OperatorPolicy("test", new()
    {
        Name = "test",
        Vhost = guest.Vhost,
        Policy = new RabbitMQ.Inputs.OperatorPolicyPolicyArgs
        {
            Pattern = ".*",
            Priority = 0,
            ApplyTo = "queues",
            Definition = 
            {
                { "message-ttl", "3600000" },
                { "expires", "1800000" },
            },
        },
    });

});

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.OperatorPolicy;
import com.pulumi.rabbitmq.OperatorPolicyArgs;
import com.pulumi.rabbitmq.inputs.OperatorPolicyPolicyArgs;
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 testOperatorPolicy = new OperatorPolicy("testOperatorPolicy", OperatorPolicyArgs.builder()
            .name("test")
            .vhost(guest.vhost())
            .policy(OperatorPolicyPolicyArgs.builder()
                .pattern(".*")
                .priority(0)
                .applyTo("queues")
                .definition(Map.ofEntries(
                    Map.entry("message-ttl", 3600000),
                    Map.entry("expires", 1800000)
                ))
                .build())
            .build());

    }
}

resources:
  test:
    type: rabbitmq:VHost
    properties:
      name: test
  guest:
    type: rabbitmq:Permissions
    properties:
      user: guest
      vhost: ${test.name}
      permissions:
        configure: .*
        write: .*
        read: .*
  testOperatorPolicy:
    type: rabbitmq:OperatorPolicy
    name: test
    properties:
      name: test
      vhost: ${guest.vhost}
      policy:
        pattern: .*
        priority: 0
        applyTo: queues
        definition:
          message-ttl: 3.6e+06
          expires: 1.8e+06

Create OperatorPolicy Resource

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

new OperatorPolicy(name: string, args: OperatorPolicyArgs, opts?: CustomResourceOptions);

@overload
def OperatorPolicy(resource_name: str,
                   args: OperatorPolicyArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def OperatorPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   policy: Optional[OperatorPolicyPolicyArgs] = None,
                   vhost: Optional[str] = None,
                   name: Optional[str] = None)

func NewOperatorPolicy(ctx *Context, name string, args OperatorPolicyArgs, opts ...ResourceOption) (*OperatorPolicy, error)

public OperatorPolicy(string name, OperatorPolicyArgs args, CustomResourceOptions? opts = null)

public OperatorPolicy(String name, OperatorPolicyArgs args)
public OperatorPolicy(String name, OperatorPolicyArgs args, CustomResourceOptions options)

type: rabbitmq:OperatorPolicy
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 OperatorPolicyArgs: 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 OperatorPolicyArgs: 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 OperatorPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args OperatorPolicyArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var operatorPolicyResource = new RabbitMQ.OperatorPolicy("operatorPolicyResource", new()
{
    Policy = new RabbitMQ.Inputs.OperatorPolicyPolicyArgs
    {
        ApplyTo = "string",
        Definition = 
        {
            { "string", "string" },
        },
        Pattern = "string",
        Priority = 0,
    },
    Vhost = "string",
    Name = "string",
});

example, err := rabbitmq.NewOperatorPolicy(ctx, "operatorPolicyResource", &rabbitmq.OperatorPolicyArgs{
	Policy: &rabbitmq.OperatorPolicyPolicyArgs{
		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"),
})

var operatorPolicyResource = new OperatorPolicy("operatorPolicyResource", OperatorPolicyArgs.builder()
    .policy(OperatorPolicyPolicyArgs.builder()
        .applyTo("string")
        .definition(Map.of("string", "string"))
        .pattern("string")
        .priority(0)
        .build())
    .vhost("string")
    .name("string")
    .build());

operator_policy_resource = rabbitmq.OperatorPolicy("operatorPolicyResource",
    policy={
        "apply_to": "string",
        "definition": {
            "string": "string",
        },
        "pattern": "string",
        "priority": 0,
    },
    vhost="string",
    name="string")

const operatorPolicyResource = new rabbitmq.OperatorPolicy("operatorPolicyResource", {
    policy: {
        applyTo: "string",
        definition: {
            string: "string",
        },
        pattern: "string",
        priority: 0,
    },
    vhost: "string",
    name: "string",
});

type: rabbitmq:OperatorPolicy
properties:
    name: string
    policy:
        applyTo: string
        definition:
            string: string
        pattern: string
        priority: 0
    vhost: string

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

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

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

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

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

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

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

Outputs

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

Get an existing OperatorPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: OperatorPolicyState, opts?: CustomResourceOptions): OperatorPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        policy: Optional[OperatorPolicyPolicyArgs] = None,
        vhost: Optional[str] = None) -> OperatorPolicy

func GetOperatorPolicy(ctx *Context, name string, id IDInput, state *OperatorPolicyState, opts ...ResourceOption) (*OperatorPolicy, error)

public static OperatorPolicy Get(string name, Input<string> id, OperatorPolicyState? state, CustomResourceOptions? opts = null)

public static OperatorPolicy get(String name, Output<String> id, OperatorPolicyState state, CustomResourceOptions options)

resources:  _:    type: rabbitmq:OperatorPolicy    get:      id: ${id}

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 operator policy.
Policy Pulumi.RabbitMQ.Inputs.OperatorPolicyPolicy: The settings of the operator policy. The structure is described below.
Vhost string: The vhost to create the resource in.

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

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

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

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

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

Supporting Types

OperatorPolicyPolicy
, OperatorPolicyPolicyArgs

ApplyTo string: Can be "queues".
Definition Dictionary<string, string>: Key/value pairs of the operator 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 be "queues".
Definition map[string]string: Key/value pairs of the operator 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 be "queues".
definition Map<String,String>: Key/value pairs of the operator 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 be "queues".
definition {[key: string]: string}: Key/value pairs of the operator 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 be "queues".
definition Mapping[str, str]: Key/value pairs of the operator 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 be "queues".
definition Map<String>: Key/value pairs of the operator 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

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

E.g.

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

pulumi/pulumi-rabbitmq

rabbitmq.OperatorPolicy

On this page

On this page

Example Usage

Create OperatorPolicy Resource

Constructor syntax

Parameters

Constructor example

OperatorPolicy Resource Properties

Inputs

Outputs

Look up Existing OperatorPolicy Resource

Supporting Types

OperatorPolicyPolicy
, OperatorPolicyPolicyArgs

Import

Package Details

On this page

On this page

rabbitmq.OperatorPolicy

On this page

On this page

Example Usage

Create OperatorPolicy Resource

Constructor syntax

Parameters

Constructor example

OperatorPolicy Resource Properties

Inputs

Outputs

Look up Existing OperatorPolicy Resource

Supporting Types

OperatorPolicyPolicy, OperatorPolicyPolicyArgs

Import

Package Details

On this page

On this page

OperatorPolicyPolicy
, OperatorPolicyPolicyArgs