Oracle Cloud Infrastructure
getOceInstances
This data source provides the list of Oce Instances in Oracle Cloud Infrastructure Content and Experience service.
Returns a list of OceInstances.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testOceInstances = Output.Create(Oci.Oce.GetOceInstances.InvokeAsync(new Oci.Oce.GetOceInstancesArgs
{
CompartmentId = @var.Compartment_id,
DisplayName = @var.Oce_instance_display_name,
State = @var.Oce_instance_state,
TenancyId = oci_identity_tenancy.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: _var.Compartment_id,
DisplayName: pulumi.StringRef(_var.Oce_instance_display_name),
State: pulumi.StringRef(_var.Oce_instance_state),
TenancyId: pulumi.StringRef(oci_identity_tenancy.Test_tenancy.Id),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_oce_instances = oci.Oce.get_oce_instances(compartment_id=var["compartment_id"],
display_name=var["oce_instance_display_name"],
state=var["oce_instance_state"],
tenancy_id=oci_identity_tenancy["test_tenancy"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testOceInstances = oci.Oce.getOceInstances({
compartmentId: _var.compartment_id,
displayName: _var.oce_instance_display_name,
state: _var.oce_instance_state,
tenancyId: oci_identity_tenancy.test_tenancy.id,
});
Coming soon!
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:
- Compartment
Id string The ID of the compartment in which to list resources.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Filters
List<Get
Oce Instances Filter> - State string
Filter results on lifecycleState.
- Tenancy
Id string The ID of the tenancy in which to list resources.
- Compartment
Id string The ID of the compartment in which to list resources.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Filters
[]Get
Oce Instances Filter - State string
Filter results on lifecycleState.
- Tenancy
Id string The ID of the tenancy in which to list resources.
- compartment
Id String The ID of the compartment in which to list resources.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters
List<Get
Instances Filter> - state String
Filter results on lifecycleState.
- tenancy
Id String The ID of the tenancy in which to list resources.
- compartment
Id string The ID of the compartment in which to list resources.
- display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters
Get
Oce Instances Filter[] - state string
Filter results on lifecycleState.
- tenancy
Id 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
Get
Oce Instances Filter] - state str
Filter results on lifecycleState.
- tenancy_
id str The ID of the tenancy in which to list resources.
- compartment
Id String The ID of the compartment in which to list resources.
- display
Name 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.
- tenancy
Id String The ID of the tenancy in which to list resources.
getOceInstances Result
The following output properties are available:
- Compartment
Id string Compartment Identifier
- Id string
The provider-assigned unique ID for this managed resource.
- Oce
Instances List<GetOce Instances Oce Instance> The list of oce_instances.
- Display
Name string - Filters
List<Get
Oce Instances Filter> - State string
The current state of the instance lifecycle.
- Tenancy
Id string Tenancy Identifier
- Compartment
Id string Compartment Identifier
- Id string
The provider-assigned unique ID for this managed resource.
- Oce
Instances []GetOce Instances Oce Instance The list of oce_instances.
- Display
Name string - Filters
[]Get
Oce Instances Filter - State string
The current state of the instance lifecycle.
- Tenancy
Id string Tenancy Identifier
- compartment
Id String Compartment Identifier
- id String
The provider-assigned unique ID for this managed resource.
- oce
Instances List<GetInstances Instance> The list of oce_instances.
- display
Name String - filters
List<Get
Instances Filter> - state String
The current state of the instance lifecycle.
- tenancy
Id String Tenancy Identifier
- compartment
Id string Compartment Identifier
- id string
The provider-assigned unique ID for this managed resource.
- oce
Instances GetOce Instances Oce Instance[] The list of oce_instances.
- display
Name string - filters
Get
Oce Instances Filter[] - state string
The current state of the instance lifecycle.
- tenancy
Id string Tenancy Identifier
- compartment_
id str Compartment Identifier
- id str
The provider-assigned unique ID for this managed resource.
- oce_
instances GetOce Instances Oce Instance] The list of oce_instances.
- display_
name str - filters
Get
Oce Instances Filter] - state str
The current state of the instance lifecycle.
- tenancy_
id str Tenancy Identifier
- compartment
Id String Compartment Identifier
- id String
The provider-assigned unique ID for this managed resource.
- oce
Instances List<Property Map> The list of oce_instances.
- display
Name String - filters List<Property Map>
- state String
The current state of the instance lifecycle.
- tenancy
Id String Tenancy Identifier
Supporting Types
GetOceInstancesFilter
GetOceInstancesOceInstance
- Add
On List<string>Features a list of add-on features for the ocm instance
- Admin
Email string Admin Email for Notification
- Compartment
Id string The ID of the compartment in which to list resources.
- 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
- 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
- Idcs
Access stringToken - Idcs
Tenancy string IDCS Tenancy Identifier
- Instance
Access stringType Flag indicating whether the instance access is private or public
- Instance
License stringType Flag indicating whether the instance license is new cloud or bring your own license
- Instance
Usage stringType Instance type based on its usage
- Lifecycle
Details string Details of the current state of the instance lifecycle
- Name string
OceInstance Name
- Object
Storage stringNamespace Object Storage Namespace of tenancy
- Service Dictionary<string, object>
SERVICE data. Example:
{"service": {"IDCS": "value"}}
- State string
Filter results on lifecycleState.
- State
Message 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.
- Dictionary<string, object>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Tenancy
Id string The ID of the tenancy in which to list resources.
- Tenancy
Name string Tenancy Name
- Time
Created string The time the the OceInstance was created. An RFC3339 formatted datetime string
- Time
Updated string The time the OceInstance was updated. An RFC3339 formatted datetime string
- Upgrade
Schedule 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
- Waf
Primary stringDomain Web Application Firewall(WAF) primary domain
- Add
On []stringFeatures a list of add-on features for the ocm instance
- Admin
Email string Admin Email for Notification
- Compartment
Id string The ID of the compartment in which to list resources.
- 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
- 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
- Idcs
Access stringToken - Idcs
Tenancy string IDCS Tenancy Identifier
- Instance
Access stringType Flag indicating whether the instance access is private or public
- Instance
License stringType Flag indicating whether the instance license is new cloud or bring your own license
- Instance
Usage stringType Instance type based on its usage
- Lifecycle
Details string Details of the current state of the instance lifecycle
- Name string
OceInstance Name
- Object
Storage stringNamespace Object Storage Namespace of tenancy
- Service map[string]interface{}
SERVICE data. Example:
{"service": {"IDCS": "value"}}
- State string
Filter results on lifecycleState.
- State
Message 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.
- map[string]interface{}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Tenancy
Id string The ID of the tenancy in which to list resources.
- Tenancy
Name string Tenancy Name
- Time
Created string The time the the OceInstance was created. An RFC3339 formatted datetime string
- Time
Updated string The time the OceInstance was updated. An RFC3339 formatted datetime string
- Upgrade
Schedule 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
- Waf
Primary stringDomain Web Application Firewall(WAF) primary domain
- add
On List<String>Features a list of add-on features for the ocm instance
- admin
Email String Admin Email for Notification
- compartment
Id String The ID of the compartment in which to list resources.
- 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
- 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
- idcs
Access StringToken - idcs
Tenancy String IDCS Tenancy Identifier
- instance
Access StringType Flag indicating whether the instance access is private or public
- instance
License StringType Flag indicating whether the instance license is new cloud or bring your own license
- instance
Usage StringType Instance type based on its usage
- lifecycle
Details String Details of the current state of the instance lifecycle
- name String
OceInstance Name
- object
Storage StringNamespace Object Storage Namespace of tenancy
- service Map<String,Object>
SERVICE data. Example:
{"service": {"IDCS": "value"}}
- state String
Filter results on lifecycleState.
- state
Message 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.
- Map<String,Object>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- tenancy
Id String The ID of the tenancy in which to list resources.
- tenancy
Name String Tenancy Name
- time
Created String The time the the OceInstance was created. An RFC3339 formatted datetime string
- time
Updated String The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgrade
Schedule 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
- waf
Primary StringDomain Web Application Firewall(WAF) primary domain
- add
On string[]Features a list of add-on features for the ocm instance
- admin
Email string Admin Email for Notification
- compartment
Id string The ID of the compartment in which to list resources.
- {[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
- {[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
- idcs
Access stringToken - idcs
Tenancy string IDCS Tenancy Identifier
- instance
Access stringType Flag indicating whether the instance access is private or public
- instance
License stringType Flag indicating whether the instance license is new cloud or bring your own license
- instance
Usage stringType Instance type based on its usage
- lifecycle
Details string Details of the current state of the instance lifecycle
- name string
OceInstance Name
- object
Storage stringNamespace Object Storage Namespace of tenancy
- service {[key: string]: any}
SERVICE data. Example:
{"service": {"IDCS": "value"}}
- state string
Filter results on lifecycleState.
- state
Message 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.
- {[key: string]: any}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- tenancy
Id string The ID of the tenancy in which to list resources.
- tenancy
Name string Tenancy Name
- time
Created string The time the the OceInstance was created. An RFC3339 formatted datetime string
- time
Updated string The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgrade
Schedule 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
- waf
Primary stringDomain Web Application Firewall(WAF) primary domain
- add_
on_ Sequence[str]features 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.
- 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
- 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_ strtoken - idcs_
tenancy str IDCS Tenancy Identifier
- instance_
access_ strtype Flag indicating whether the instance access is private or public
- instance_
license_ strtype Flag indicating whether the instance license is new cloud or bring your own license
- instance_
usage_ strtype Instance type based on its usage
- lifecycle_
details str Details of the current state of the instance lifecycle
- name str
OceInstance Name
- object_
storage_ strnamespace 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.
- 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_ strdomain Web Application Firewall(WAF) primary domain
- add
On List<String>Features a list of add-on features for the ocm instance
- admin
Email String Admin Email for Notification
- compartment
Id String The ID of the compartment in which to list resources.
- 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
- 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
- idcs
Access StringToken - idcs
Tenancy String IDCS Tenancy Identifier
- instance
Access StringType Flag indicating whether the instance access is private or public
- instance
License StringType Flag indicating whether the instance license is new cloud or bring your own license
- instance
Usage StringType Instance type based on its usage
- lifecycle
Details String Details of the current state of the instance lifecycle
- name String
OceInstance Name
- object
Storage StringNamespace Object Storage Namespace of tenancy
- service Map<Any>
SERVICE data. Example:
{"service": {"IDCS": "value"}}
- state String
Filter results on lifecycleState.
- state
Message 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.
- Map<Any>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- tenancy
Id String The ID of the tenancy in which to list resources.
- tenancy
Name String Tenancy Name
- time
Created String The time the the OceInstance was created. An RFC3339 formatted datetime string
- time
Updated String The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgrade
Schedule 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
- waf
Primary StringDomain Web Application Firewall(WAF) primary domain
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.