Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. VisualBuilder
  5. getVbInstance
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.VisualBuilder.getVbInstance

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Vb Instance resource in Oracle Cloud Infrastructure Visual Builder service.

    Gets a VbInstance by identifier

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testVbInstance = oci.VisualBuilder.getVbInstance({
    vbInstanceId: testVbInstanceOciVisualBuilderVbInstance.id,
});

    import pulumi
import pulumi_oci as oci

test_vb_instance = oci.VisualBuilder.get_vb_instance(vb_instance_id=test_vb_instance_oci_visual_builder_vb_instance["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/visualbuilder"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := visualbuilder.GetVbInstance(ctx, &visualbuilder.GetVbInstanceArgs{
			VbInstanceId: testVbInstanceOciVisualBuilderVbInstance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVbInstance = Oci.VisualBuilder.GetVbInstance.Invoke(new()
    {
        VbInstanceId = testVbInstanceOciVisualBuilderVbInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.VisualBuilder.VisualBuilderFunctions;
import com.pulumi.oci.VisualBuilder.inputs.GetVbInstanceArgs;
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) {
        final var testVbInstance = VisualBuilderFunctions.getVbInstance(GetVbInstanceArgs.builder()
            .vbInstanceId(testVbInstanceOciVisualBuilderVbInstance.id())
            .build());

    }
}

    variables:
  testVbInstance:
    fn::invoke:
      function: oci:VisualBuilder:getVbInstance
      arguments:
        vbInstanceId: ${testVbInstanceOciVisualBuilderVbInstance.id}

    Using getVbInstance

    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 getVbInstance(args: GetVbInstanceArgs, opts?: InvokeOptions): Promise<GetVbInstanceResult>
function getVbInstanceOutput(args: GetVbInstanceOutputArgs, opts?: InvokeOptions): Output<GetVbInstanceResult>
    def get_vb_instance(vb_instance_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVbInstanceResult
def get_vb_instance_output(vb_instance_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVbInstanceResult]
    func GetVbInstance(ctx *Context, args *GetVbInstanceArgs, opts ...InvokeOption) (*GetVbInstanceResult, error)
func GetVbInstanceOutput(ctx *Context, args *GetVbInstanceOutputArgs, opts ...InvokeOption) GetVbInstanceResultOutput

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

    public static class GetVbInstance 
{
    public static Task<GetVbInstanceResult> InvokeAsync(GetVbInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetVbInstanceResult> Invoke(GetVbInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVbInstanceResult> getVbInstance(GetVbInstanceArgs args, InvokeOptions options)
public static Output<GetVbInstanceResult> getVbInstance(GetVbInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:VisualBuilder/getVbInstance:getVbInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VbInstanceId string
    Unique Vb Instance identifier.
    VbInstanceId string
    Unique Vb Instance identifier.
    vbInstanceId String
    Unique Vb Instance identifier.
    vbInstanceId string
    Unique Vb Instance identifier.
    vb_instance_id str
    Unique Vb Instance identifier.
    vbInstanceId String
    Unique Vb Instance identifier.

    getVbInstance Result

    The following output properties are available:

    AlternateCustomEndpoints List<GetVbInstanceAlternateCustomEndpoint>
    A list of alternate custom endpoints used for the vb instance URL.
    CompartmentId string
    Compartment Identifier.
    ConsumptionModel string
    The entitlement used for billing purposes.
    CustomEndpoints List<GetVbInstanceCustomEndpoint>
    Details for a custom endpoint for the vb instance.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Vb Instance Identifier, can be renamed.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    IdcsOpenId string
    InstanceUrl string
    The Vb Instance URL.
    IsVisualBuilderEnabled bool
    Visual Builder is enabled or not.
    ManagementNatGatewayIp string
    The NAT gateway IP address for the VB management VCN
    ManagementVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    NetworkEndpointDetails List<GetVbInstanceNetworkEndpointDetail>
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    NodeCount int
    The number of Nodes
    ServiceNatGatewayIp string
    The NAT gateway IP address for the VB service VCN
    ServiceVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    State string
    The current state of the vb instance.
    StateMessage string
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    VbInstanceId string
    AlternateCustomEndpoints []GetVbInstanceAlternateCustomEndpoint
    A list of alternate custom endpoints used for the vb instance URL.
    CompartmentId string
    Compartment Identifier.
    ConsumptionModel string
    The entitlement used for billing purposes.
    CustomEndpoints []GetVbInstanceCustomEndpoint
    Details for a custom endpoint for the vb instance.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Vb Instance Identifier, can be renamed.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    IdcsOpenId string
    InstanceUrl string
    The Vb Instance URL.
    IsVisualBuilderEnabled bool
    Visual Builder is enabled or not.
    ManagementNatGatewayIp string
    The NAT gateway IP address for the VB management VCN
    ManagementVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    NetworkEndpointDetails []GetVbInstanceNetworkEndpointDetail
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    NodeCount int
    The number of Nodes
    ServiceNatGatewayIp string
    The NAT gateway IP address for the VB service VCN
    ServiceVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    State string
    The current state of the vb instance.
    StateMessage string
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    VbInstanceId string
    alternateCustomEndpoints List<GetVbInstanceAlternateCustomEndpoint>
    A list of alternate custom endpoints used for the vb instance URL.
    compartmentId String
    Compartment Identifier.
    consumptionModel String
    The entitlement used for billing purposes.
    customEndpoints List<GetVbInstanceCustomEndpoint>
    Details for a custom endpoint for the vb instance.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Vb Instance Identifier, can be renamed.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    idcsOpenId String
    instanceUrl String
    The Vb Instance URL.
    isVisualBuilderEnabled Boolean
    Visual Builder is enabled or not.
    managementNatGatewayIp String
    The NAT gateway IP address for the VB management VCN
    managementVcnId String
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    networkEndpointDetails List<GetVbInstanceNetworkEndpointDetail>
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    nodeCount Integer
    The number of Nodes
    serviceNatGatewayIp String
    The NAT gateway IP address for the VB service VCN
    serviceVcnId String
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    state String
    The current state of the vb instance.
    stateMessage String
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    vbInstanceId String
    alternateCustomEndpoints GetVbInstanceAlternateCustomEndpoint[]
    A list of alternate custom endpoints used for the vb instance URL.
    compartmentId string
    Compartment Identifier.
    consumptionModel string
    The entitlement used for billing purposes.
    customEndpoints GetVbInstanceCustomEndpoint[]
    Details for a custom endpoint for the vb instance.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    Vb Instance Identifier, can be renamed.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    Unique identifier that is immutable on creation.
    idcsOpenId string
    instanceUrl string
    The Vb Instance URL.
    isVisualBuilderEnabled boolean
    Visual Builder is enabled or not.
    managementNatGatewayIp string
    The NAT gateway IP address for the VB management VCN
    managementVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    networkEndpointDetails GetVbInstanceNetworkEndpointDetail[]
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    nodeCount number
    The number of Nodes
    serviceNatGatewayIp string
    The NAT gateway IP address for the VB service VCN
    serviceVcnId string
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    state string
    The current state of the vb instance.
    stateMessage string
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    vbInstanceId string
    alternate_custom_endpoints Sequence[visualbuilder.GetVbInstanceAlternateCustomEndpoint]
    A list of alternate custom endpoints used for the vb instance URL.
    compartment_id str
    Compartment Identifier.
    consumption_model str
    The entitlement used for billing purposes.
    custom_endpoints Sequence[visualbuilder.GetVbInstanceCustomEndpoint]
    Details for a custom endpoint for the vb instance.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    Vb Instance Identifier, can be renamed.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    Unique identifier that is immutable on creation.
    idcs_open_id str
    instance_url str
    The Vb Instance URL.
    is_visual_builder_enabled bool
    Visual Builder is enabled or not.
    management_nat_gateway_ip str
    The NAT gateway IP address for the VB management VCN
    management_vcn_id str
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    network_endpoint_details Sequence[visualbuilder.GetVbInstanceNetworkEndpointDetail]
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    node_count int
    The number of Nodes
    service_nat_gateway_ip str
    The NAT gateway IP address for the VB service VCN
    service_vcn_id str
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    state str
    The current state of the vb instance.
    state_message str
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    vb_instance_id str
    alternateCustomEndpoints List<Property Map>
    A list of alternate custom endpoints used for the vb instance URL.
    compartmentId String
    Compartment Identifier.
    consumptionModel String
    The entitlement used for billing purposes.
    customEndpoints List<Property Map>
    Details for a custom endpoint for the vb instance.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Vb Instance Identifier, can be renamed.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    idcsOpenId String
    instanceUrl String
    The Vb Instance URL.
    isVisualBuilderEnabled Boolean
    Visual Builder is enabled or not.
    managementNatGatewayIp String
    The NAT gateway IP address for the VB management VCN
    managementVcnId String
    The Oracle Cloud ID (OCID) of the Visual Builder management VCN
    networkEndpointDetails List<Property Map>
    Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance.
    nodeCount Number
    The number of Nodes
    serviceNatGatewayIp String
    The NAT gateway IP address for the VB service VCN
    serviceVcnId String
    The Oracle Cloud ID (OCID) of the Visual Builder service VCN
    state String
    The current state of the vb instance.
    stateMessage String
    An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the VbInstance was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the VbInstance was updated. An RFC3339 formatted datetime string.
    vbInstanceId String

    Supporting Types

    GetVbInstanceAlternateCustomEndpoint

    CertificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    CertificateSecretVersion int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    Hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    CertificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    CertificateSecretVersion int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    Hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId String
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion Integer
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname String
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion number
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificate_secret_id str
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificate_secret_version int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname str
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId String
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion Number
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname String
    A custom hostname to be used for the vb instance URL, in FQDN format.

    GetVbInstanceCustomEndpoint

    CertificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    CertificateSecretVersion int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    Hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    CertificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    CertificateSecretVersion int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    Hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId String
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion Integer
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname String
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId string
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion number
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname string
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificate_secret_id str
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificate_secret_version int
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname str
    A custom hostname to be used for the vb instance URL, in FQDN format.
    certificateSecretId String
    Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.
    certificateSecretVersion Number
    The secret version used for the certificate-secret-id (if certificate-secret-id is specified).
    hostname String
    A custom hostname to be used for the vb instance URL, in FQDN format.

    GetVbInstanceNetworkEndpointDetail

    NetworkEndpointType string
    The type of network endpoint.
    NetworkSecurityGroupIds List<string>
    Network Security Group OCIDs for the Private Endpoint.
    PrivateEndpointIp string
    The IP address to be assigned to Private Endpoint
    SubnetId string
    The subnet OCID for the private endpoint.
    NetworkEndpointType string
    The type of network endpoint.
    NetworkSecurityGroupIds []string
    Network Security Group OCIDs for the Private Endpoint.
    PrivateEndpointIp string
    The IP address to be assigned to Private Endpoint
    SubnetId string
    The subnet OCID for the private endpoint.
    networkEndpointType String
    The type of network endpoint.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for the Private Endpoint.
    privateEndpointIp String
    The IP address to be assigned to Private Endpoint
    subnetId String
    The subnet OCID for the private endpoint.
    networkEndpointType string
    The type of network endpoint.
    networkSecurityGroupIds string[]
    Network Security Group OCIDs for the Private Endpoint.
    privateEndpointIp string
    The IP address to be assigned to Private Endpoint
    subnetId string
    The subnet OCID for the private endpoint.
    network_endpoint_type str
    The type of network endpoint.
    network_security_group_ids Sequence[str]
    Network Security Group OCIDs for the Private Endpoint.
    private_endpoint_ip str
    The IP address to be assigned to Private Endpoint
    subnet_id str
    The subnet OCID for the private endpoint.
    networkEndpointType String
    The type of network endpoint.
    networkSecurityGroupIds List<String>
    Network Security Group OCIDs for the Private Endpoint.
    privateEndpointIp String
    The IP address to be assigned to Private Endpoint
    subnetId String
    The subnet OCID for the private endpoint.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci