Skip to content

vbsinst.oracle.com/v1beta1

Back to API Reference

APIVersion: vbsinst.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes vbsinst.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
VbsInstance Namespaced Sample -

VbsInstance

Manage OCI Visual Builder Studio instances.

  • Plural: vbsinstances
  • Scope: Namespaced
  • APIVersion: vbsinst.oracle.com/v1beta1
  • Sample: Sample (config/samples/vbsinst_v1beta1_vbsinstance.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

VbsInstanceSpec defines the desired state of VbsInstance.

Field Description Type Required Default Enum
compartmentId Compartment Identifier string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Display Name string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
isResourceUsageAgreementGranted Whether VBS is authorized to create and use resources in the customer tenancy boolean No - -
name Service Instance Name string Yes - -
resourceCompartmentId Compartment where VBS may create additional resources for the service instance string No - -

Status

VbsInstanceStatus defines the observed state of VbsInstance.

Field Description Type Required Default Enum
compartmentId Compartment of the service instance string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Service instance display name string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id Unique identifier that is immutable on creation string No - -
isResourceUsageAgreementGranted Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy boolean No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current state of the VbsInstance. string No - -
name Service instance name (unique identifier) string No - -
resourceCompartmentId Compartment where VBS may create additional resources for the service instance string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the the VbsInstance was created. An RFC3339 formatted datetime string string No - -
timeUpdated The time the VbsInstance was updated. An RFC3339 formatted datetime string string No - -
vbsAccessUrl Public web URL for accessing the VBS service instance string No - -

Status.status

Back to VbsInstance status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to VbsInstance status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to VbsInstance status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to VbsInstance status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -