Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. RabbitMQ
  5. VHost

VHost

The rabbitmq.VHost resource creates and manages a vhost.

Example Usage

using Pulumi;
using RabbitMQ = Pulumi.RabbitMQ;

class MyStack : Stack
{
    public MyStack()
    {
        var myVhost = new RabbitMQ.VHost("myVhost", new RabbitMQ.VHostArgs
        {
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-rabbitmq/sdk/v2/go/rabbitmq"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rabbitmq.NewVHost(ctx, "myVhost", nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rabbitmq as rabbitmq

my_vhost = rabbitmq.VHost("myVhost")
import * as pulumi from "@pulumi/pulumi";
import * as rabbitmq from "@pulumi/rabbitmq";

const myVhost = new rabbitmq.VHost("my_vhost", {});

Create a VHost Resource

new VHost(name: string, args?: VHostArgs, opts?: CustomResourceOptions);
def VHost(resource_name: str, opts: Optional[ResourceOptions] = None, name: Optional[str] = None)
func NewVHost(ctx *Context, name string, args *VHostArgs, opts ...ResourceOption) (*VHost, error)
public VHost(string name, VHostArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VHostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VHost Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VHost resource accepts the following input properties:

Name string

The name of the vhost.

Name string

The name of the vhost.

name string

The name of the vhost.

name str

The name of the vhost.

Outputs

All input properties are implicitly available as output properties. Additionally, the VHost 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing VHost Resource

Get an existing VHost 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?: VHostState, opts?: CustomResourceOptions): VHost
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, name: Optional[str] = None) -> VHost
func GetVHost(ctx *Context, name string, id IDInput, state *VHostState, opts ...ResourceOption) (*VHost, error)
public static VHost Get(string name, Input<string> id, VHostState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Name string

The name of the vhost.

Name string

The name of the vhost.

name string

The name of the vhost.

name str

The name of the vhost.

Import

Vhosts can be imported using the name, e.g.

 $ pulumi import rabbitmq:index/vHost:VHost my_vhost my_vhost

Package Details

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