← All packages

Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Source code

getOdaInstances

This data source provides the list of Oda Instances in Oracle Cloud Infrastructure Digital Assistant service.

Returns a page of Digital Assistant instances that belong to the specified compartment.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header’s value as the page query parameter.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testOdaInstances = Output.Create(Oci.Oda.GetOdaInstances.InvokeAsync(new Oci.Oda.GetOdaInstancesArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Oda_instance_display_name,
            State = @var.Oda_instance_state,
        }));
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Oda.GetOdaInstances(ctx, &oda.GetOdaInstancesArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Oda_instance_display_name),
			State:         pulumi.StringRef(_var.Oda_instance_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_oda_instances = oci.Oda.get_oda_instances(compartment_id=var["compartment_id"],
    display_name=var["oda_instance_display_name"],
    state=var["oda_instance_state"])

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

const testOdaInstances = oci.Oda.getOdaInstances({
    compartmentId: _var.compartment_id,
    displayName: _var.oda_instance_display_name,
    state: _var.oda_instance_state,
});

Coming soon!

Using getOdaInstances

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 getOdaInstances(args: GetOdaInstancesArgs, opts?: InvokeOptions): Promise<GetOdaInstancesResult>
function getOdaInstancesOutput(args: GetOdaInstancesOutputArgs, opts?: InvokeOptions): Output<GetOdaInstancesResult>

def get_oda_instances(compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_oda.GetOdaInstancesFilter]] = None,
                      state: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOdaInstancesResult
def get_oda_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_oda.GetOdaInstancesFilterArgs]]]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOdaInstancesResult]

func GetOdaInstances(ctx *Context, args *GetOdaInstancesArgs, opts ...InvokeOption) (*GetOdaInstancesResult, error)
func GetOdaInstancesOutput(ctx *Context, args *GetOdaInstancesOutputArgs, opts ...InvokeOption) GetOdaInstancesResultOutput

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

public static class GetOdaInstances 
{
    public static Task<GetOdaInstancesResult> InvokeAsync(GetOdaInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetOdaInstancesResult> Invoke(GetOdaInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOdaInstancesResult> getOdaInstances(GetOdaInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:Oda/getOdaInstances:getOdaInstances
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string: List the Digital Assistant instances that belong to this compartment.
DisplayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
Filters List<GetOdaInstancesFilter>
State string: List only the Digital Assistant instances that are in this lifecycle state.

CompartmentId string: List the Digital Assistant instances that belong to this compartment.
DisplayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
Filters []GetOdaInstancesFilter
State string: List only the Digital Assistant instances that are in this lifecycle state.

compartmentId String: List the Digital Assistant instances that belong to this compartment.
displayName String: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
filters List<GetInstancesFilter>
state String: List only the Digital Assistant instances that are in this lifecycle state.

compartmentId string: List the Digital Assistant instances that belong to this compartment.
displayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
filters GetOdaInstancesFilter[]
state string: List only the Digital Assistant instances that are in this lifecycle state.

compartment_id str: List the Digital Assistant instances that belong to this compartment.
display_name str: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
filters GetOdaInstancesFilter]
state str: List only the Digital Assistant instances that are in this lifecycle state.

compartmentId String: List the Digital Assistant instances that belong to this compartment.
displayName String: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
filters List<Property Map>
state String: List only the Digital Assistant instances that are in this lifecycle state.

getOdaInstances Result

The following output properties are available:

CompartmentId string: Identifier of the compartment that the instance belongs to.
Id string: The provider-assigned unique ID for this managed resource.
OdaInstances List<GetOdaInstancesOdaInstance>: The list of oda_instances.
DisplayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
Filters List<GetOdaInstancesFilter>
State string: The current state of the Digital Assistant instance.

CompartmentId string: Identifier of the compartment that the instance belongs to.
Id string: The provider-assigned unique ID for this managed resource.
OdaInstances []GetOdaInstancesOdaInstance: The list of oda_instances.
DisplayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
Filters []GetOdaInstancesFilter
State string: The current state of the Digital Assistant instance.

compartmentId String: Identifier of the compartment that the instance belongs to.
id String: The provider-assigned unique ID for this managed resource.
odaInstances List<GetInstancesInstance>: The list of oda_instances.
displayName String: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
filters List<GetInstancesFilter>
state String: The current state of the Digital Assistant instance.

compartmentId string: Identifier of the compartment that the instance belongs to.
id string: The provider-assigned unique ID for this managed resource.
odaInstances GetOdaInstancesOdaInstance[]: The list of oda_instances.
displayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
filters GetOdaInstancesFilter[]
state string: The current state of the Digital Assistant instance.

compartment_id str: Identifier of the compartment that the instance belongs to.
id str: The provider-assigned unique ID for this managed resource.
oda_instances GetOdaInstancesOdaInstance]: The list of oda_instances.
display_name str: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
filters GetOdaInstancesFilter]
state str: The current state of the Digital Assistant instance.

compartmentId String: Identifier of the compartment that the instance belongs to.
id String: The provider-assigned unique ID for this managed resource.
odaInstances List<Property Map>: The list of oda_instances.
displayName String: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
filters List<Property Map>
state String: The current state of the Digital Assistant instance.

Supporting Types

GetOdaInstancesFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetOdaInstancesOdaInstance

CompartmentId string: List the Digital Assistant instances that belong to this compartment.
ConnectorUrl string: URL for the connector's endpoint.
DefinedTags Dictionary<string, object>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string: Description of the Digital Assistant instance.
DisplayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
Id string: Unique immutable identifier that was assigned when the instance was created.
LifecycleSubState string: The current sub-state of the Digital Assistant instance.
ShapeName string: Shape or size of the instance.
State string: List only the Digital Assistant instances that are in this lifecycle state.
StateMessage string: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
TimeCreated string: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
TimeUpdated string: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
WebAppUrl string: URL for the Digital Assistant web application that's associated with the instance.

CompartmentId string: List the Digital Assistant instances that belong to this compartment.
ConnectorUrl string: URL for the connector's endpoint.
DefinedTags map[string]interface{}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string: Description of the Digital Assistant instance.
DisplayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
Id string: Unique immutable identifier that was assigned when the instance was created.
LifecycleSubState string: The current sub-state of the Digital Assistant instance.
ShapeName string: Shape or size of the instance.
State string: List only the Digital Assistant instances that are in this lifecycle state.
StateMessage string: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
TimeCreated string: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
TimeUpdated string: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
WebAppUrl string: URL for the Digital Assistant web application that's associated with the instance.

compartmentId String: List the Digital Assistant instances that belong to this compartment.
connectorUrl String: URL for the connector's endpoint.
definedTags Map<String,Object>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String: Description of the Digital Assistant instance.
displayName String: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
id String: Unique immutable identifier that was assigned when the instance was created.
lifecycleSubState String: The current sub-state of the Digital Assistant instance.
shapeName String: Shape or size of the instance.
state String: List only the Digital Assistant instances that are in this lifecycle state.
stateMessage String: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
timeCreated String: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
timeUpdated String: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
webAppUrl String: URL for the Digital Assistant web application that's associated with the instance.

compartmentId string: List the Digital Assistant instances that belong to this compartment.
connectorUrl string: URL for the connector's endpoint.
definedTags {[key: string]: any}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description string: Description of the Digital Assistant instance.
displayName string: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
id string: Unique immutable identifier that was assigned when the instance was created.
lifecycleSubState string: The current sub-state of the Digital Assistant instance.
shapeName string: Shape or size of the instance.
state string: List only the Digital Assistant instances that are in this lifecycle state.
stateMessage string: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
timeCreated string: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
timeUpdated string: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
webAppUrl string: URL for the Digital Assistant web application that's associated with the instance.

compartment_id str: List the Digital Assistant instances that belong to this compartment.
connector_url str: URL for the connector's endpoint.
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: Description of the Digital Assistant instance.
display_name str: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
id str: Unique immutable identifier that was assigned when the instance was created.
lifecycle_sub_state str: The current sub-state of the Digital Assistant instance.
shape_name str: Shape or size of the instance.
state str: List only the Digital Assistant instances that are in this lifecycle state.
state_message str: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
time_created str: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
time_updated str: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
web_app_url str: URL for the Digital Assistant web application that's associated with the instance.

compartmentId String: List the Digital Assistant instances that belong to this compartment.
connectorUrl String: URL for the connector's endpoint.
definedTags Map<Any>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String: Description of the Digital Assistant instance.
displayName String: List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: My new resource
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"}
id String: Unique immutable identifier that was assigned when the instance was created.
lifecycleSubState String: The current sub-state of the Digital Assistant instance.
shapeName String: Shape or size of the instance.
state String: List only the Digital Assistant instances that are in this lifecycle state.
stateMessage String: A message that describes the current state in more detail. For example, actionable information about an instance that's in the FAILED state.
timeCreated String: When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
timeUpdated String: When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
webAppUrl String: URL for the Digital Assistant web application that's associated with the instance.

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.