1. Packages
  2. CloudAMQP
  3. API Docs
  4. getInstance
CloudAMQP v3.17.4 published on Monday, Feb 19, 2024 by Pulumi

cloudamqp.getInstance

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.17.4 published on Monday, Feb 19, 2024 by Pulumi

    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.

    Attributes reference

    All attributes reference are computed

    • id - The identifier for this resource.
    • name - The name of the CloudAMQP instance.
    • plan - The subscription plan for the CloudAMQP instance.
    • region - The cloud platform and region that host the CloudAMQP instance, {platform}::{region}.
    • vpc_id - ID of the VPC configured for the CloudAMQP instance.
    • vpc_subnet - Dedicated VPC subnet configured for the CloudAMQP instance.
    • nodes - Number of nodes in the cluster of the CloudAMQP instance.
    • rmq_version - The version of installed Rabbit MQ.
    • url - (Sensitive) The AMQP URL (uses the internal hostname if the instance was created with VPC), used by clients to connect for pub/sub.
    • apikey - (Sensitive) The API key to secondary API handing alarms, integration etc.
    • tags - Tags the CloudAMQP instance with categories.
    • host - The external hostname for the CloudAMQP instance.
    • host_internal - The internal hostname for the CloudAMQP instance.
    • vhost - The virtual host configured in Rabbit MQ.
    • dedicated - Information if the CloudAMQP instance is shared or dedicated.
    • backend - Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.

    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)
    // Output-based functions aren't available in Java yet
    
    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
    Backend string
    Dedicated bool
    Host string
    HostInternal string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId int
    Name string
    NoDefaultAlarms bool
    Nodes int
    Plan string
    Ready bool
    Region string
    RmqVersion string
    Tags List<string>
    Url string
    Vhost string
    VpcId int
    VpcSubnet string
    Apikey string
    Backend string
    Dedicated bool
    Host string
    HostInternal string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId int
    Name string
    NoDefaultAlarms bool
    Nodes int
    Plan string
    Ready bool
    Region string
    RmqVersion string
    Tags []string
    Url string
    Vhost string
    VpcId int
    VpcSubnet string
    apikey String
    backend String
    dedicated Boolean
    host String
    hostInternal String
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId Integer
    name String
    noDefaultAlarms Boolean
    nodes Integer
    plan String
    ready Boolean
    region String
    rmqVersion String
    tags List<String>
    url String
    vhost String
    vpcId Integer
    vpcSubnet String
    apikey string
    backend string
    dedicated boolean
    host string
    hostInternal string
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId number
    name string
    noDefaultAlarms boolean
    nodes number
    plan string
    ready boolean
    region string
    rmqVersion string
    tags string[]
    url string
    vhost string
    vpcId number
    vpcSubnet string
    apikey str
    backend str
    dedicated bool
    host str
    host_internal str
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id int
    name str
    no_default_alarms bool
    nodes int
    plan str
    ready bool
    region str
    rmq_version str
    tags Sequence[str]
    url str
    vhost str
    vpc_id int
    vpc_subnet str
    apikey String
    backend String
    dedicated Boolean
    host String
    hostInternal String
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId Number
    name String
    noDefaultAlarms Boolean
    nodes Number
    plan String
    ready Boolean
    region String
    rmqVersion String
    tags List<String>
    url String
    vhost String
    vpcId Number
    vpcSubnet String

    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.17.4 published on Monday, Feb 19, 2024 by Pulumi