1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rabbitmq
  6. getInstance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::RabbitMQ::Instance

    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(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetInstanceResult
    def get_instance_output(id: Optional[pulumi.Input[str]] = 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: volcenginecc:rabbitmq/getInstance:getInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getInstance Result

    The following output properties are available:

    AccountId string
    Main account ID used to create the instance.
    ApplyPrivateDnsToPublic bool
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    ArchType string
    Instance type, either cluster or standalone.
    ChargeDetail Volcengine.GetInstanceChargeDetail
    Instance billing method and related billing information.
    ComputeSpec string
    Compute specification of the RabbitMQ instance.
    CreatedTime string
    Instance creation time.
    EipId string
    EIP ID.
    Endpoints List<Volcengine.GetInstanceEndpoint>
    Instance connection information.
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Brief description of the instance.
    InstanceId string
    RabbitMQ instance ID.
    InstanceName string
    RabbitMQ instance name.
    InstanceStatus string
    Instance status.
    IsEncrypted bool
    Whether cloud disk encryption is enabled.
    ProjectName string
    IAM project to which the instance belongs.
    StorageSpace int
    Total storage space of the instance, measured in GiB.
    SubnetId string
    VPC subnet ID.
    Tags List<Volcengine.GetInstanceTag>
    Tags bound to the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UserName string
    RabbitMQ WebUI administrator account name.
    UserPassword string
    RabbitMQ WebUI administrator password.
    Version string
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    VpcId string
    Private network (VPC) ID.
    ZoneDescription string
    Description of the availability zone.
    ZoneId string
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.
    AccountId string
    Main account ID used to create the instance.
    ApplyPrivateDnsToPublic bool
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    ArchType string
    Instance type, either cluster or standalone.
    ChargeDetail GetInstanceChargeDetail
    Instance billing method and related billing information.
    ComputeSpec string
    Compute specification of the RabbitMQ instance.
    CreatedTime string
    Instance creation time.
    EipId string
    EIP ID.
    Endpoints []GetInstanceEndpoint
    Instance connection information.
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Brief description of the instance.
    InstanceId string
    RabbitMQ instance ID.
    InstanceName string
    RabbitMQ instance name.
    InstanceStatus string
    Instance status.
    IsEncrypted bool
    Whether cloud disk encryption is enabled.
    ProjectName string
    IAM project to which the instance belongs.
    StorageSpace int
    Total storage space of the instance, measured in GiB.
    SubnetId string
    VPC subnet ID.
    Tags []GetInstanceTag
    Tags bound to the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UserName string
    RabbitMQ WebUI administrator account name.
    UserPassword string
    RabbitMQ WebUI administrator password.
    Version string
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    VpcId string
    Private network (VPC) ID.
    ZoneDescription string
    Description of the availability zone.
    ZoneId string
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.
    accountId String
    Main account ID used to create the instance.
    applyPrivateDnsToPublic Boolean
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    archType String
    Instance type, either cluster or standalone.
    chargeDetail GetInstanceChargeDetail
    Instance billing method and related billing information.
    computeSpec String
    Compute specification of the RabbitMQ instance.
    createdTime String
    Instance creation time.
    eipId String
    EIP ID.
    endpoints List<GetInstanceEndpoint>
    Instance connection information.
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Brief description of the instance.
    instanceId String
    RabbitMQ instance ID.
    instanceName String
    RabbitMQ instance name.
    instanceStatus String
    Instance status.
    isEncrypted Boolean
    Whether cloud disk encryption is enabled.
    projectName String
    IAM project to which the instance belongs.
    storageSpace Integer
    Total storage space of the instance, measured in GiB.
    subnetId String
    VPC subnet ID.
    tags List<GetInstanceTag>
    Tags bound to the instance.
    usedStorageSpace Integer
    Used storage space of the instance, measured in GiB.
    userName String
    RabbitMQ WebUI administrator account name.
    userPassword String
    RabbitMQ WebUI administrator password.
    version String
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    vpcId String
    Private network (VPC) ID.
    zoneDescription String
    Description of the availability zone.
    zoneId String
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.
    accountId string
    Main account ID used to create the instance.
    applyPrivateDnsToPublic boolean
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    archType string
    Instance type, either cluster or standalone.
    chargeDetail GetInstanceChargeDetail
    Instance billing method and related billing information.
    computeSpec string
    Compute specification of the RabbitMQ instance.
    createdTime string
    Instance creation time.
    eipId string
    EIP ID.
    endpoints GetInstanceEndpoint[]
    Instance connection information.
    id string
    Uniquely identifies the resource.
    instanceDescription string
    Brief description of the instance.
    instanceId string
    RabbitMQ instance ID.
    instanceName string
    RabbitMQ instance name.
    instanceStatus string
    Instance status.
    isEncrypted boolean
    Whether cloud disk encryption is enabled.
    projectName string
    IAM project to which the instance belongs.
    storageSpace number
    Total storage space of the instance, measured in GiB.
    subnetId string
    VPC subnet ID.
    tags GetInstanceTag[]
    Tags bound to the instance.
    usedStorageSpace number
    Used storage space of the instance, measured in GiB.
    userName string
    RabbitMQ WebUI administrator account name.
    userPassword string
    RabbitMQ WebUI administrator password.
    version string
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    vpcId string
    Private network (VPC) ID.
    zoneDescription string
    Description of the availability zone.
    zoneId string
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.
    account_id str
    Main account ID used to create the instance.
    apply_private_dns_to_public bool
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    arch_type str
    Instance type, either cluster or standalone.
    charge_detail GetInstanceChargeDetail
    Instance billing method and related billing information.
    compute_spec str
    Compute specification of the RabbitMQ instance.
    created_time str
    Instance creation time.
    eip_id str
    EIP ID.
    endpoints Sequence[GetInstanceEndpoint]
    Instance connection information.
    id str
    Uniquely identifies the resource.
    instance_description str
    Brief description of the instance.
    instance_id str
    RabbitMQ instance ID.
    instance_name str
    RabbitMQ instance name.
    instance_status str
    Instance status.
    is_encrypted bool
    Whether cloud disk encryption is enabled.
    project_name str
    IAM project to which the instance belongs.
    storage_space int
    Total storage space of the instance, measured in GiB.
    subnet_id str
    VPC subnet ID.
    tags Sequence[GetInstanceTag]
    Tags bound to the instance.
    used_storage_space int
    Used storage space of the instance, measured in GiB.
    user_name str
    RabbitMQ WebUI administrator account name.
    user_password str
    RabbitMQ WebUI administrator password.
    version str
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    vpc_id str
    Private network (VPC) ID.
    zone_description str
    Description of the availability zone.
    zone_id str
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.
    accountId String
    Main account ID used to create the instance.
    applyPrivateDnsToPublic Boolean
    Whether public DNS resolution is enabled. true: enabled, false: disabled.
    archType String
    Instance type, either cluster or standalone.
    chargeDetail Property Map
    Instance billing method and related billing information.
    computeSpec String
    Compute specification of the RabbitMQ instance.
    createdTime String
    Instance creation time.
    eipId String
    EIP ID.
    endpoints List<Property Map>
    Instance connection information.
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Brief description of the instance.
    instanceId String
    RabbitMQ instance ID.
    instanceName String
    RabbitMQ instance name.
    instanceStatus String
    Instance status.
    isEncrypted Boolean
    Whether cloud disk encryption is enabled.
    projectName String
    IAM project to which the instance belongs.
    storageSpace Number
    Total storage space of the instance, measured in GiB.
    subnetId String
    VPC subnet ID.
    tags List<Property Map>
    Tags bound to the instance.
    usedStorageSpace Number
    Used storage space of the instance, measured in GiB.
    userName String
    RabbitMQ WebUI administrator account name.
    userPassword String
    RabbitMQ WebUI administrator password.
    version String
    Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.
    vpcId String
    Private network (VPC) ID.
    zoneDescription String
    Description of the availability zone.
    zoneId String
    Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.

    Supporting Types

    GetInstanceChargeDetail

    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration.
    ChargeEndTime string
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeExpireTime string
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeStartTime string
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeStatus string
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    ChargeType string
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    OverdueTime string
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    Period int
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    PeriodUnit string
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.
    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration.
    ChargeEndTime string
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeExpireTime string
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeStartTime string
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    ChargeStatus string
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    ChargeType string
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    OverdueTime string
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    Period int
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    PeriodUnit string
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration.
    chargeEndTime String
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeExpireTime String
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStartTime String
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStatus String
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    chargeType String
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    overdueReclaimTime String
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    overdueTime String
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    period Integer
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    periodUnit String
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.
    autoRenew boolean
    Whether to automatically renew the subscription instance after expiration.
    chargeEndTime string
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeExpireTime string
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStartTime string
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStatus string
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    chargeType string
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    overdueReclaimTime string
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    overdueTime string
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    period number
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    periodUnit string
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.
    auto_renew bool
    Whether to automatically renew the subscription instance after expiration.
    charge_end_time str
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    charge_expire_time str
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    charge_start_time str
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    charge_status str
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    charge_type str
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    overdue_reclaim_time str
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    overdue_time str
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    period int
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    period_unit str
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration.
    chargeEndTime String
    Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeExpireTime String
    Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStartTime String
    Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
    chargeStatus String
    Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.
    chargeType String
    Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.
    overdueReclaimTime String
    Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    overdueTime String
    Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    period Number
    Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.
    periodUnit String
    Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.

    GetInstanceEndpoint

    EndpointType string
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    InternalEndpoint string
    Private network access domain name of the instance.
    InternalIpEndpoint string
    Public service zone IP endpoint.
    NetworkType string
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    PublicEndpoint string
    Instance public access domain name. Displayed only after public access is enabled.
    EndpointType string
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    InternalEndpoint string
    Private network access domain name of the instance.
    InternalIpEndpoint string
    Public service zone IP endpoint.
    NetworkType string
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    PublicEndpoint string
    Instance public access domain name. Displayed only after public access is enabled.
    endpointType String
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    internalEndpoint String
    Private network access domain name of the instance.
    internalIpEndpoint String
    Public service zone IP endpoint.
    networkType String
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    publicEndpoint String
    Instance public access domain name. Displayed only after public access is enabled.
    endpointType string
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    internalEndpoint string
    Private network access domain name of the instance.
    internalIpEndpoint string
    Public service zone IP endpoint.
    networkType string
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    publicEndpoint string
    Instance public access domain name. Displayed only after public access is enabled.
    endpoint_type str
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    internal_endpoint str
    Private network access domain name of the instance.
    internal_ip_endpoint str
    Public service zone IP endpoint.
    network_type str
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    public_endpoint str
    Instance public access domain name. Displayed only after public access is enabled.
    endpointType String
    Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP091: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.
    internalEndpoint String
    Private network access domain name of the instance.
    internalIpEndpoint String
    Public service zone IP endpoint.
    networkType String
    Network type of the endpoint. PrivateNetwork indicates a private network (VPC).
    publicEndpoint String
    Instance public access domain name. Displayed only after public access is enabled.

    GetInstanceTag

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.