Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. getInstance
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.getInstance

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

    Use this data source to retrieve information about an already created CloudAMQP instance. In order to retrieve the correct information, the CoudAMQP instance identifier is needed.

    Using getInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_id: Optional[int] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[int]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudamqp:index/getInstance:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId int
    The CloudAMQP instance identifier.
    InstanceId int
    The CloudAMQP instance identifier.
    instanceId Integer
    The CloudAMQP instance identifier.
    instanceId number
    The CloudAMQP instance identifier.
    instance_id int
    The CloudAMQP instance identifier.
    instanceId Number
    The CloudAMQP instance identifier.

    getInstance Result

    The following output properties are available:

    Apikey string
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    Backend string
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    Dedicated bool
    Information if the CloudAMQP instance is shared or dedicated.
    Host string
    The external hostname for the CloudAMQP instance.
    HostInternal string
    The internal hostname for the CloudAMQP instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId int
    Name string
    The name of the CloudAMQP instance.
    NoDefaultAlarms bool
    Nodes int
    Number of nodes in the cluster of the CloudAMQP instance.
    Plan string
    The subscription plan for the CloudAMQP instance.
    Ready bool
    Region string
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    RmqVersion string
    The version of installed Rabbit MQ.
    Tags List<string>
    Tags the CloudAMQP instance with categories.
    Url string
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    Vhost string
    The virtual host configured in Rabbit MQ.
    VpcId int
    ID of the VPC configured for the CloudAMQP instance.
    VpcSubnet string
    Dedicated VPC subnet configured for the CloudAMQP instance.
    Apikey string
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    Backend string
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    Dedicated bool
    Information if the CloudAMQP instance is shared or dedicated.
    Host string
    The external hostname for the CloudAMQP instance.
    HostInternal string
    The internal hostname for the CloudAMQP instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId int
    Name string
    The name of the CloudAMQP instance.
    NoDefaultAlarms bool
    Nodes int
    Number of nodes in the cluster of the CloudAMQP instance.
    Plan string
    The subscription plan for the CloudAMQP instance.
    Ready bool
    Region string
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    RmqVersion string
    The version of installed Rabbit MQ.
    Tags []string
    Tags the CloudAMQP instance with categories.
    Url string
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    Vhost string
    The virtual host configured in Rabbit MQ.
    VpcId int
    ID of the VPC configured for the CloudAMQP instance.
    VpcSubnet string
    Dedicated VPC subnet configured for the CloudAMQP instance.
    apikey String
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    backend String
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    dedicated Boolean
    Information if the CloudAMQP instance is shared or dedicated.
    host String
    The external hostname for the CloudAMQP instance.
    hostInternal String
    The internal hostname for the CloudAMQP instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId Integer
    name String
    The name of the CloudAMQP instance.
    noDefaultAlarms Boolean
    nodes Integer
    Number of nodes in the cluster of the CloudAMQP instance.
    plan String
    The subscription plan for the CloudAMQP instance.
    ready Boolean
    region String
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    rmqVersion String
    The version of installed Rabbit MQ.
    tags List<String>
    Tags the CloudAMQP instance with categories.
    url String
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    vhost String
    The virtual host configured in Rabbit MQ.
    vpcId Integer
    ID of the VPC configured for the CloudAMQP instance.
    vpcSubnet String
    Dedicated VPC subnet configured for the CloudAMQP instance.
    apikey string
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    backend string
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    dedicated boolean
    Information if the CloudAMQP instance is shared or dedicated.
    host string
    The external hostname for the CloudAMQP instance.
    hostInternal string
    The internal hostname for the CloudAMQP instance.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId number
    name string
    The name of the CloudAMQP instance.
    noDefaultAlarms boolean
    nodes number
    Number of nodes in the cluster of the CloudAMQP instance.
    plan string
    The subscription plan for the CloudAMQP instance.
    ready boolean
    region string
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    rmqVersion string
    The version of installed Rabbit MQ.
    tags string[]
    Tags the CloudAMQP instance with categories.
    url string
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    vhost string
    The virtual host configured in Rabbit MQ.
    vpcId number
    ID of the VPC configured for the CloudAMQP instance.
    vpcSubnet string
    Dedicated VPC subnet configured for the CloudAMQP instance.
    apikey str
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    backend str
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    dedicated bool
    Information if the CloudAMQP instance is shared or dedicated.
    host str
    The external hostname for the CloudAMQP instance.
    host_internal str
    The internal hostname for the CloudAMQP instance.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id int
    name str
    The name of the CloudAMQP instance.
    no_default_alarms bool
    nodes int
    Number of nodes in the cluster of the CloudAMQP instance.
    plan str
    The subscription plan for the CloudAMQP instance.
    ready bool
    region str
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    rmq_version str
    The version of installed Rabbit MQ.
    tags Sequence[str]
    Tags the CloudAMQP instance with categories.
    url str
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    vhost str
    The virtual host configured in Rabbit MQ.
    vpc_id int
    ID of the VPC configured for the CloudAMQP instance.
    vpc_subnet str
    Dedicated VPC subnet configured for the CloudAMQP instance.
    apikey String
    (Sensitive) The API key to secondary API handing alarms, integration etc.
    backend String
    Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
    dedicated Boolean
    Information if the CloudAMQP instance is shared or dedicated.
    host String
    The external hostname for the CloudAMQP instance.
    hostInternal String
    The internal hostname for the CloudAMQP instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId Number
    name String
    The name of the CloudAMQP instance.
    noDefaultAlarms Boolean
    nodes Number
    Number of nodes in the cluster of the CloudAMQP instance.
    plan String
    The subscription plan for the CloudAMQP instance.
    ready Boolean
    region String
    The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    rmqVersion String
    The version of installed Rabbit MQ.
    tags List<String>
    Tags the CloudAMQP instance with categories.
    url String
    (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    vhost String
    The virtual host configured in Rabbit MQ.
    vpcId Number
    ID of the VPC configured for the CloudAMQP instance.
    vpcSubnet String
    Dedicated VPC subnet configured for the CloudAMQP instance.

    Package Details

    Repository
    CloudAMQP pulumi/pulumi-cloudamqp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudamqp Terraform Provider.
    cloudamqp logo
    CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-cloudamqp