1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Oce
  5. getOceInstances
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Oce.getOceInstances

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This data source provides the list of Oce Instances in Oracle Cloud Infrastructure Content and Experience service.

    Returns a list of OceInstances.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOceInstances = oci.Oce.getOceInstances({
        compartmentId: compartmentId,
        displayName: oceInstanceDisplayName,
        state: oceInstanceState,
        tenancyId: testTenancy.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_oce_instances = oci.Oce.get_oce_instances(compartment_id=compartment_id,
        display_name=oce_instance_display_name,
        state=oce_instance_state,
        tenancy_id=test_tenancy["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Oce"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Oce.GetOceInstances(ctx, &oce.GetOceInstancesArgs{
    			CompartmentId: compartmentId,
    			DisplayName:   pulumi.StringRef(oceInstanceDisplayName),
    			State:         pulumi.StringRef(oceInstanceState),
    			TenancyId:     pulumi.StringRef(testTenancy.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 testOceInstances = Oci.Oce.GetOceInstances.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = oceInstanceDisplayName,
            State = oceInstanceState,
            TenancyId = testTenancy.Id,
        });
    
    });
    
    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.GetOceInstancesArgs;
    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 testOceInstances = OceFunctions.getOceInstances(GetOceInstancesArgs.builder()
                .compartmentId(compartmentId)
                .displayName(oceInstanceDisplayName)
                .state(oceInstanceState)
                .tenancyId(testTenancy.id())
                .build());
    
        }
    }
    
    variables:
      testOceInstances:
        fn::invoke:
          Function: oci:Oce:getOceInstances
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${oceInstanceDisplayName}
            state: ${oceInstanceState}
            tenancyId: ${testTenancy.id}
    

    Using getOceInstances

    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 getOceInstances(args: GetOceInstancesArgs, opts?: InvokeOptions): Promise<GetOceInstancesResult>
    function getOceInstancesOutput(args: GetOceInstancesOutputArgs, opts?: InvokeOptions): Output<GetOceInstancesResult>
    def get_oce_instances(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_oce.GetOceInstancesFilter]] = None,
                          state: Optional[str] = None,
                          tenancy_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOceInstancesResult
    def get_oce_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_oce.GetOceInstancesFilterArgs]]]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          tenancy_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOceInstancesResult]
    func GetOceInstances(ctx *Context, args *GetOceInstancesArgs, opts ...InvokeOption) (*GetOceInstancesResult, error)
    func GetOceInstancesOutput(ctx *Context, args *GetOceInstancesOutputArgs, opts ...InvokeOption) GetOceInstancesResultOutput

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

    public static class GetOceInstances 
    {
        public static Task<GetOceInstancesResult> InvokeAsync(GetOceInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetOceInstancesResult> Invoke(GetOceInstancesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOceInstancesResult> getOceInstances(GetOceInstancesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Oce/getOceInstances:getOceInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    Filters List<GetOceInstancesFilter>
    State string
    Filter results on lifecycleState.
    TenancyId string
    The ID of the tenancy in which to list resources.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    Filters []GetOceInstancesFilter
    State string
    Filter results on lifecycleState.
    TenancyId string
    The ID of the tenancy in which to list resources.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    filters List<GetInstancesFilter>
    state String
    Filter results on lifecycleState.
    tenancyId String
    The ID of the tenancy in which to list resources.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    filters GetOceInstancesFilter[]
    state string
    Filter results on lifecycleState.
    tenancyId string
    The ID of the tenancy in which to list resources.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    filters Sequence[oce.GetOceInstancesFilter]
    state str
    Filter results on lifecycleState.
    tenancy_id str
    The ID of the tenancy in which to list resources.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
    filters List<Property Map>
    state String
    Filter results on lifecycleState.
    tenancyId String
    The ID of the tenancy in which to list resources.

    getOceInstances Result

    The following output properties are available:

    CompartmentId string
    Compartment Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    OceInstances List<GetOceInstancesOceInstance>
    The list of oce_instances.
    DisplayName string
    Filters List<GetOceInstancesFilter>
    State string
    The current state of the instance lifecycle.
    TenancyId string
    Tenancy Identifier
    CompartmentId string
    Compartment Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    OceInstances []GetOceInstancesOceInstance
    The list of oce_instances.
    DisplayName string
    Filters []GetOceInstancesFilter
    State string
    The current state of the instance lifecycle.
    TenancyId string
    Tenancy Identifier
    compartmentId String
    Compartment Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    oceInstances List<GetInstancesInstance>
    The list of oce_instances.
    displayName String
    filters List<GetInstancesFilter>
    state String
    The current state of the instance lifecycle.
    tenancyId String
    Tenancy Identifier
    compartmentId string
    Compartment Identifier
    id string
    The provider-assigned unique ID for this managed resource.
    oceInstances GetOceInstancesOceInstance[]
    The list of oce_instances.
    displayName string
    filters GetOceInstancesFilter[]
    state string
    The current state of the instance lifecycle.
    tenancyId string
    Tenancy Identifier
    compartment_id str
    Compartment Identifier
    id str
    The provider-assigned unique ID for this managed resource.
    oce_instances Sequence[oce.GetOceInstancesOceInstance]
    The list of oce_instances.
    display_name str
    filters Sequence[oce.GetOceInstancesFilter]
    state str
    The current state of the instance lifecycle.
    tenancy_id str
    Tenancy Identifier
    compartmentId String
    Compartment Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    oceInstances List<Property Map>
    The list of oce_instances.
    displayName String
    filters List<Property Map>
    state String
    The current state of the instance lifecycle.
    tenancyId String
    Tenancy Identifier

    Supporting Types

    GetOceInstancesFilter

    Name string
    OceInstance Name
    Values List<string>
    Regex bool
    Name string
    OceInstance Name
    Values []string
    Regex bool
    name String
    OceInstance Name
    values List<String>
    regex Boolean
    name string
    OceInstance Name
    values string[]
    regex boolean
    name str
    OceInstance Name
    values Sequence[str]
    regex bool
    name String
    OceInstance Name
    values List<String>
    regex Boolean

    GetOceInstancesOceInstance

    AddOnFeatures List<string>
    a list of add-on features for the ocm instance
    AdminEmail string
    Admin Email for Notification
    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags Dictionary<string, object>
    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, object>
    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
    Service Dictionary<string, object>
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    State string
    Filter results on lifecycleState.
    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, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenancyId string
    The ID of the tenancy in which to list resources.
    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
    The ID of the compartment in which to list resources.
    DefinedTags map[string]interface{}
    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]interface{}
    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
    Service map[string]interface{}
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    State string
    Filter results on lifecycleState.
    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]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenancyId string
    The ID of the tenancy in which to list resources.
    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
    The ID of the compartment in which to list resources.
    definedTags Map<String,Object>
    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,Object>
    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
    service Map<String,Object>
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    state String
    Filter results on lifecycleState.
    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,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId String
    The ID of the tenancy in which to list resources.
    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
    The ID of the compartment in which to list resources.
    definedTags {[key: string]: any}
    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]: any}
    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
    service {[key: string]: any}
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    state string
    Filter results on lifecycleState.
    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]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId string
    The ID of the tenancy in which to list resources.
    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
    The ID of the compartment in which to list resources.
    defined_tags Mapping[str, Any]
    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, Any]
    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
    service Mapping[str, Any]
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    state str
    Filter results on lifecycleState.
    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, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancy_id str
    The ID of the tenancy in which to list resources.
    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
    The ID of the compartment in which to list resources.
    definedTags Map<Any>
    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<Any>
    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
    service Map<Any>
    SERVICE data. Example: {"service": {"IDCS": "value"}}
    state String
    Filter results on lifecycleState.
    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<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId String
    The ID of the tenancy in which to list resources.
    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.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi