1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Oce
  5. getOceInstance
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Oce.getOceInstance

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides details about a specific Oce Instance resource in Oracle Cloud Infrastructure Content and Experience service.

Gets a OceInstance by identifier

Example Usage

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

const testOceInstance = oci.Oce.getOceInstance({
    oceInstanceId: testOceInstanceOciOceOceInstance.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_oce_instance = oci.Oce.get_oce_instance(oce_instance_id=test_oce_instance_oci_oce_oce_instance["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oce.GetOceInstance(ctx, &oce.GetOceInstanceArgs{
			OceInstanceId: testOceInstanceOciOceOceInstance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOceInstance = Oci.Oce.GetOceInstance.Invoke(new()
    {
        OceInstanceId = testOceInstanceOciOceOceInstance.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Oce.OceFunctions;
import com.pulumi.oci.Oce.inputs.GetOceInstanceArgs;
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 testOceInstance = OceFunctions.getOceInstance(GetOceInstanceArgs.builder()
            .oceInstanceId(testOceInstanceOciOceOceInstance.id())
            .build());

    }
}
Copy
variables:
  testOceInstance:
    fn::invoke:
      function: oci:Oce:getOceInstance
      arguments:
        oceInstanceId: ${testOceInstanceOciOceOceInstance.id}
Copy

Using getOceInstance

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 getOceInstance(args: GetOceInstanceArgs, opts?: InvokeOptions): Promise<GetOceInstanceResult>
function getOceInstanceOutput(args: GetOceInstanceOutputArgs, opts?: InvokeOptions): Output<GetOceInstanceResult>
Copy
def get_oce_instance(oce_instance_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOceInstanceResult
def get_oce_instance_output(oce_instance_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOceInstanceResult]
Copy
func GetOceInstance(ctx *Context, args *GetOceInstanceArgs, opts ...InvokeOption) (*GetOceInstanceResult, error)
func GetOceInstanceOutput(ctx *Context, args *GetOceInstanceOutputArgs, opts ...InvokeOption) GetOceInstanceResultOutput
Copy

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

public static class GetOceInstance 
{
    public static Task<GetOceInstanceResult> InvokeAsync(GetOceInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetOceInstanceResult> Invoke(GetOceInstanceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOceInstanceResult> getOceInstance(GetOceInstanceArgs args, InvokeOptions options)
public static Output<GetOceInstanceResult> getOceInstance(GetOceInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Oce/getOceInstance:getOceInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OceInstanceId This property is required. string
unique OceInstance identifier
OceInstanceId This property is required. string
unique OceInstance identifier
oceInstanceId This property is required. String
unique OceInstance identifier
oceInstanceId This property is required. string
unique OceInstance identifier
oce_instance_id This property is required. str
unique OceInstance identifier
oceInstanceId This property is required. String
unique OceInstance identifier

getOceInstance Result

The following output properties are available:

AddOnFeatures List<string>
a list of add-on features for the ocm instance
AdminEmail string
Admin Email for Notification
CompartmentId string
Compartment Identifier
DefinedTags Dictionary<string, string>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
OceInstance description, can be updated
DrRegion string
disaster recovery paired ragion name
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"}
Guid string
Unique GUID identifier that is immutable on creation
Id string
Unique identifier that is immutable on creation
IdcsAccessToken string
IdcsTenancy string
IDCS Tenancy Identifier
InstanceAccessType string
Flag indicating whether the instance access is private or public
InstanceLicenseType string
Flag indicating whether the instance license is new cloud or bring your own license
InstanceUsageType string
Instance type based on its usage
LifecycleDetails string
Details of the current state of the instance lifecycle
Name string
OceInstance Name
ObjectStorageNamespace string
Object Storage Namespace of tenancy
OceInstanceId string
Service Dictionary<string, string>
SERVICE data. Example: {"service": {"IDCS": "value"}}
State string
The current state of the instance lifecycle.
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"}
TenancyId string
Tenancy Identifier
TenancyName string
Tenancy Name
TimeCreated string
The time the the OceInstance was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the OceInstance was updated. An RFC3339 formatted datetime string
UpgradeSchedule string
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
WafPrimaryDomain string
Web Application Firewall(WAF) primary domain
AddOnFeatures []string
a list of add-on features for the ocm instance
AdminEmail string
Admin Email for Notification
CompartmentId string
Compartment Identifier
DefinedTags map[string]string
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
OceInstance description, can be updated
DrRegion string
disaster recovery paired ragion name
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"}
Guid string
Unique GUID identifier that is immutable on creation
Id string
Unique identifier that is immutable on creation
IdcsAccessToken string
IdcsTenancy string
IDCS Tenancy Identifier
InstanceAccessType string
Flag indicating whether the instance access is private or public
InstanceLicenseType string
Flag indicating whether the instance license is new cloud or bring your own license
InstanceUsageType string
Instance type based on its usage
LifecycleDetails string
Details of the current state of the instance lifecycle
Name string
OceInstance Name
ObjectStorageNamespace string
Object Storage Namespace of tenancy
OceInstanceId string
Service map[string]string
SERVICE data. Example: {"service": {"IDCS": "value"}}
State string
The current state of the instance lifecycle.
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"}
TenancyId string
Tenancy Identifier
TenancyName string
Tenancy Name
TimeCreated string
The time the the OceInstance was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the OceInstance was updated. An RFC3339 formatted datetime string
UpgradeSchedule string
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
WafPrimaryDomain string
Web Application Firewall(WAF) primary domain
addOnFeatures List<String>
a list of add-on features for the ocm instance
adminEmail String
Admin Email for Notification
compartmentId String
Compartment Identifier
definedTags Map<String,String>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
OceInstance description, can be updated
drRegion String
disaster recovery paired ragion name
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"}
guid String
Unique GUID identifier that is immutable on creation
id String
Unique identifier that is immutable on creation
idcsAccessToken String
idcsTenancy String
IDCS Tenancy Identifier
instanceAccessType String
Flag indicating whether the instance access is private or public
instanceLicenseType String
Flag indicating whether the instance license is new cloud or bring your own license
instanceUsageType String
Instance type based on its usage
lifecycleDetails String
Details of the current state of the instance lifecycle
name String
OceInstance Name
objectStorageNamespace String
Object Storage Namespace of tenancy
oceInstanceId String
service Map<String,String>
SERVICE data. Example: {"service": {"IDCS": "value"}}
state String
The current state of the instance lifecycle.
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"}
tenancyId String
Tenancy Identifier
tenancyName String
Tenancy Name
timeCreated String
The time the the OceInstance was created. An RFC3339 formatted datetime string
timeUpdated String
The time the OceInstance was updated. An RFC3339 formatted datetime string
upgradeSchedule String
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
wafPrimaryDomain String
Web Application Firewall(WAF) primary domain
addOnFeatures string[]
a list of add-on features for the ocm instance
adminEmail string
Admin Email for Notification
compartmentId string
Compartment Identifier
definedTags {[key: string]: string}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description string
OceInstance description, can be updated
drRegion string
disaster recovery paired ragion name
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"}
guid string
Unique GUID identifier that is immutable on creation
id string
Unique identifier that is immutable on creation
idcsAccessToken string
idcsTenancy string
IDCS Tenancy Identifier
instanceAccessType string
Flag indicating whether the instance access is private or public
instanceLicenseType string
Flag indicating whether the instance license is new cloud or bring your own license
instanceUsageType string
Instance type based on its usage
lifecycleDetails string
Details of the current state of the instance lifecycle
name string
OceInstance Name
objectStorageNamespace string
Object Storage Namespace of tenancy
oceInstanceId string
service {[key: string]: string}
SERVICE data. Example: {"service": {"IDCS": "value"}}
state string
The current state of the instance lifecycle.
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"}
tenancyId string
Tenancy Identifier
tenancyName string
Tenancy Name
timeCreated string
The time the the OceInstance was created. An RFC3339 formatted datetime string
timeUpdated string
The time the OceInstance was updated. An RFC3339 formatted datetime string
upgradeSchedule string
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
wafPrimaryDomain string
Web Application Firewall(WAF) primary domain
add_on_features Sequence[str]
a list of add-on features for the ocm instance
admin_email str
Admin Email for Notification
compartment_id str
Compartment Identifier
defined_tags Mapping[str, str]
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description str
OceInstance description, can be updated
dr_region str
disaster recovery paired ragion name
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"}
guid str
Unique GUID identifier that is immutable on creation
id str
Unique identifier that is immutable on creation
idcs_access_token str
idcs_tenancy str
IDCS Tenancy Identifier
instance_access_type str
Flag indicating whether the instance access is private or public
instance_license_type str
Flag indicating whether the instance license is new cloud or bring your own license
instance_usage_type str
Instance type based on its usage
lifecycle_details str
Details of the current state of the instance lifecycle
name str
OceInstance Name
object_storage_namespace str
Object Storage Namespace of tenancy
oce_instance_id str
service Mapping[str, str]
SERVICE data. Example: {"service": {"IDCS": "value"}}
state str
The current state of the instance lifecycle.
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"}
tenancy_id str
Tenancy Identifier
tenancy_name str
Tenancy Name
time_created str
The time the the OceInstance was created. An RFC3339 formatted datetime string
time_updated str
The time the OceInstance was updated. An RFC3339 formatted datetime string
upgrade_schedule str
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
waf_primary_domain str
Web Application Firewall(WAF) primary domain
addOnFeatures List<String>
a list of add-on features for the ocm instance
adminEmail String
Admin Email for Notification
compartmentId String
Compartment Identifier
definedTags Map<String>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
OceInstance description, can be updated
drRegion String
disaster recovery paired ragion name
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"}
guid String
Unique GUID identifier that is immutable on creation
id String
Unique identifier that is immutable on creation
idcsAccessToken String
idcsTenancy String
IDCS Tenancy Identifier
instanceAccessType String
Flag indicating whether the instance access is private or public
instanceLicenseType String
Flag indicating whether the instance license is new cloud or bring your own license
instanceUsageType String
Instance type based on its usage
lifecycleDetails String
Details of the current state of the instance lifecycle
name String
OceInstance Name
objectStorageNamespace String
Object Storage Namespace of tenancy
oceInstanceId String
service Map<String>
SERVICE data. Example: {"service": {"IDCS": "value"}}
state String
The current state of the instance lifecycle.
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"}
tenancyId String
Tenancy Identifier
tenancyName String
Tenancy Name
timeCreated String
The time the the OceInstance was created. An RFC3339 formatted datetime string
timeUpdated String
The time the OceInstance was updated. An RFC3339 formatted datetime string
upgradeSchedule String
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
wafPrimaryDomain String
Web Application Firewall(WAF) primary domain

Package Details

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