rabbitmq.VHost
Explore with Pulumi AI
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("my_vhost", {name: "my_vhost"});
import pulumi
import pulumi_rabbitmq as rabbitmq
my_vhost = rabbitmq.VHost("my_vhost", name="my_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 {
_, err := rabbitmq.NewVHost(ctx, "my_vhost", &rabbitmq.VHostArgs{
Name: pulumi.String("my_vhost"),
})
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("my_vhost", new()
{
Name = "my_vhost",
});
});
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 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", VHostArgs.builder()
.name("my_vhost")
.build());
}
}
resources:
myVhost:
type: rabbitmq:VHost
name: my_vhost
properties:
name: my_vhost
Create VHost Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VHost(name: string, args?: VHostArgs, opts?: CustomResourceOptions);
@overload
def VHost(resource_name: str,
args: Optional[VHostArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
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)
type: rabbitmq:VHost
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 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var vhostResource = new RabbitMQ.VHost("vhostResource", new()
{
Name = "string",
});
example, err := rabbitmq.NewVHost(ctx, "vhostResource", &rabbitmq.VHostArgs{
Name: pulumi.String("string"),
})
var vhostResource = new VHost("vhostResource", VHostArgs.builder()
.name("string")
.build());
vhost_resource = rabbitmq.VHost("vhostResource", name="string")
const vhostResource = new rabbitmq.VHost("vhostResource", {name: "string"});
type: rabbitmq:VHost
properties:
name: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.
- 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
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.