1. Packages
  2. RabbitMQ
  3. API Docs
  4. VHost
RabbitMQ v3.3.2 published on Thursday, Mar 21, 2024 by Pulumi

rabbitmq.VHost

Explore with Pulumi AI

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

    The rabbitmq.VHost resource creates and manages a vhost.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rabbitmq from "@pulumi/rabbitmq";
    
    const myVhost = new rabbitmq.VHost("myVhost", {});
    
    import pulumi
    import pulumi_rabbitmq as rabbitmq
    
    my_vhost = rabbitmq.VHost("myVhost")
    
    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 {
    		_, err := rabbitmq.NewVHost(ctx, "myVhost", nil)
    		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 myVhost = new RabbitMQ.VHost("myVhost");
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rabbitmq.VHost;
    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 myVhost = new VHost("myVhost");
    
        }
    }
    
    resources:
      myVhost:
        type: rabbitmq:VHost
    

    Create VHost Resource

    new VHost(name: string, args?: VHostArgs, opts?: CustomResourceOptions);
    @overload
    def VHost(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None)
    @overload
    def VHost(resource_name: str,
              args: Optional[VHostArgs] = None,
              opts: Optional[ResourceOptions] = None)
    func NewVHost(ctx *Context, name string, args *VHostArgs, opts ...ResourceOption) (*VHost, error)
    public VHost(string name, VHostArgs? args = null, CustomResourceOptions? opts = null)
    public VHost(String name, VHostArgs args)
    public VHost(String name, VHostArgs args, CustomResourceOptions options)
    
    type: rabbitmq:VHost
    properties: # The arguments to resource properties.
    options: # 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.
    resource_name str
    The unique name of the resource.
    args VHostArgs
    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 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.
    name String
    The unique name of the resource.
    args VHostArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts 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 string
    The name of the vhost.
    name str
    The name of the vhost.
    name String
    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 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 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)
    public static VHost get(String name, Output<String> id, VHostState 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 vhost.
    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.
    name String
    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
    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