Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.Oda.getOdaInstance
Explore with Pulumi AI
This data source provides details about a specific Oda Instance resource in Oracle Cloud Infrastructure Digital Assistant service.
Gets the specified Digital Assistant instance.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testOdaInstance = oci.Oda.getOdaInstance({
odaInstanceId: testOdaInstanceOciOdaOdaInstance.id,
});
import pulumi
import pulumi_oci as oci
test_oda_instance = oci.Oda.get_oda_instance(oda_instance_id=test_oda_instance_oci_oda_oda_instance["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Oda"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Oda.GetOdaInstance(ctx, &oda.GetOdaInstanceArgs{
OdaInstanceId: testOdaInstanceOciOdaOdaInstance.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 testOdaInstance = Oci.Oda.GetOdaInstance.Invoke(new()
{
OdaInstanceId = testOdaInstanceOciOdaOdaInstance.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Oda.OdaFunctions;
import com.pulumi.oci.Oda.inputs.GetOdaInstanceArgs;
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 testOdaInstance = OdaFunctions.getOdaInstance(GetOdaInstanceArgs.builder()
.odaInstanceId(testOdaInstanceOciOdaOdaInstance.id())
.build());
}
}
variables:
testOdaInstance:
fn::invoke:
Function: oci:Oda:getOdaInstance
Arguments:
odaInstanceId: ${testOdaInstanceOciOdaOdaInstance.id}
Using getOdaInstance
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 getOdaInstance(args: GetOdaInstanceArgs, opts?: InvokeOptions): Promise<GetOdaInstanceResult>
function getOdaInstanceOutput(args: GetOdaInstanceOutputArgs, opts?: InvokeOptions): Output<GetOdaInstanceResult>
def get_oda_instance(oda_instance_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOdaInstanceResult
def get_oda_instance_output(oda_instance_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetOdaInstanceResult]
func GetOdaInstance(ctx *Context, args *GetOdaInstanceArgs, opts ...InvokeOption) (*GetOdaInstanceResult, error)
func GetOdaInstanceOutput(ctx *Context, args *GetOdaInstanceOutputArgs, opts ...InvokeOption) GetOdaInstanceResultOutput
> Note: This function is named GetOdaInstance
in the Go SDK.
public static class GetOdaInstance
{
public static Task<GetOdaInstanceResult> InvokeAsync(GetOdaInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetOdaInstanceResult> Invoke(GetOdaInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOdaInstanceResult> getOdaInstance(GetOdaInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Oda/getOdaInstance:getOdaInstance
arguments:
# arguments dictionary
The following arguments are supported:
- Oda
Instance stringId - Unique Digital Assistant instance identifier.
- Oda
Instance stringId - Unique Digital Assistant instance identifier.
- oda
Instance StringId - Unique Digital Assistant instance identifier.
- oda
Instance stringId - Unique Digital Assistant instance identifier.
- oda_
instance_ strid - Unique Digital Assistant instance identifier.
- oda
Instance StringId - Unique Digital Assistant instance identifier.
getOdaInstance Result
The following output properties are available:
- Attachment
Ids List<string> - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- Attachment
Types List<string> - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- Compartment
Id string - Identifier of the compartment that the instance belongs to.
- Connector
Url string - URL for the connector's endpoint.
- Dictionary<string, string>
- 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.
- Display
Name string - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- Id string
- Unique immutable identifier that was assigned when the instance was created.
- Identity
App stringConsole Url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- Identity
App stringGuid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- Identity
Domain string - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- Imported
Package List<string>Ids - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- Imported
Package List<string>Names - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- Is
Role boolBased Access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- Lifecycle
Sub stringState - The current sub-state of the Digital Assistant instance.
- Oda
Instance stringId - Restricted
Operations List<GetOda Instance Restricted Operation> - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- Shape
Name string - Shape or size of the instance.
- State string
- The current state of the Digital Assistant instance.
- State
Message string - 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 string - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- Time
Updated string - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- Web
App stringUrl - URL for the Digital Assistant web application that's associated with the instance.
- Attachment
Ids []string - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- Attachment
Types []string - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- Compartment
Id string - Identifier of the compartment that the instance belongs to.
- Connector
Url string - URL for the connector's endpoint.
- map[string]string
- 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.
- Display
Name string - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- Id string
- Unique immutable identifier that was assigned when the instance was created.
- Identity
App stringConsole Url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- Identity
App stringGuid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- Identity
Domain string - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- Imported
Package []stringIds - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- Imported
Package []stringNames - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- Is
Role boolBased Access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- Lifecycle
Sub stringState - The current sub-state of the Digital Assistant instance.
- Oda
Instance stringId - Restricted
Operations []GetOda Instance Restricted Operation - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- Shape
Name string - Shape or size of the instance.
- State string
- The current state of the Digital Assistant instance.
- State
Message string - 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 string - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- Time
Updated string - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- Web
App stringUrl - URL for the Digital Assistant web application that's associated with the instance.
- attachment
Ids List<String> - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- attachment
Types List<String> - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- compartment
Id String - Identifier of the compartment that the instance belongs to.
- connector
Url String - URL for the connector's endpoint.
- Map<String,String>
- 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.
- display
Name String - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- id String
- Unique immutable identifier that was assigned when the instance was created.
- identity
App StringConsole Url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- identity
App StringGuid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- identity
Domain String - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- imported
Package List<String>Ids - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- imported
Package List<String>Names - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- is
Role BooleanBased Access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- lifecycle
Sub StringState - The current sub-state of the Digital Assistant instance.
- oda
Instance StringId - restricted
Operations List<GetInstance Restricted Operation> - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- shape
Name String - Shape or size of the instance.
- state String
- The current state of the Digital Assistant instance.
- state
Message String - 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 String - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated String - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App StringUrl - URL for the Digital Assistant web application that's associated with the instance.
- attachment
Ids string[] - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- attachment
Types string[] - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- compartment
Id string - Identifier of the compartment that the instance belongs to.
- connector
Url string - URL for the connector's endpoint.
- {[key: string]: string}
- 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.
- display
Name string - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- id string
- Unique immutable identifier that was assigned when the instance was created.
- identity
App stringConsole Url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- identity
App stringGuid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- identity
Domain string - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- imported
Package string[]Ids - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- imported
Package string[]Names - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- is
Role booleanBased Access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- lifecycle
Sub stringState - The current sub-state of the Digital Assistant instance.
- oda
Instance stringId - restricted
Operations GetOda Instance Restricted Operation[] - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- shape
Name string - Shape or size of the instance.
- state string
- The current state of the Digital Assistant instance.
- state
Message string - 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 string - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated string - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App stringUrl - URL for the Digital Assistant web application that's associated with the instance.
- attachment_
ids Sequence[str] - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- attachment_
types Sequence[str] - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- compartment_
id str - Identifier of the compartment that the instance belongs to.
- connector_
url str - URL for the connector's endpoint.
- Mapping[str, str]
- 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 - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- id str
- Unique immutable identifier that was assigned when the instance was created.
- identity_
app_ strconsole_ url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- identity_
app_ strguid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- identity_
domain str - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- imported_
package_ Sequence[str]ids - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- imported_
package_ Sequence[str]names - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- is_
role_ boolbased_ access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- lifecycle_
sub_ strstate - The current sub-state of the Digital Assistant instance.
- oda_
instance_ strid - restricted_
operations Sequence[oda.Get Oda Instance Restricted Operation] - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- shape_
name str - Shape or size of the instance.
- state str
- The current state of the Digital Assistant instance.
- 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_ strurl - URL for the Digital Assistant web application that's associated with the instance.
- attachment
Ids List<String> - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- attachment
Types List<String> - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
- compartment
Id String - Identifier of the compartment that the instance belongs to.
- connector
Url String - URL for the connector's endpoint.
- Map<String>
- 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.
- display
Name String - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
- id String
- Unique immutable identifier that was assigned when the instance was created.
- identity
App StringConsole Url - If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
- identity
App StringGuid - If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
- identity
Domain String - If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- imported
Package List<String>Ids - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
- imported
Package List<String>Names - A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
- is
Role BooleanBased Access - Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- lifecycle
Sub StringState - The current sub-state of the Digital Assistant instance.
- oda
Instance StringId - restricted
Operations List<Property Map> - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
- shape
Name String - Shape or size of the instance.
- state String
- The current state of the Digital Assistant instance.
- state
Message String - 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 String - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated String - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App StringUrl - URL for the Digital Assistant web application that's associated with the instance.
Supporting Types
GetOdaInstanceRestrictedOperation
- Operation
Name string - Name of the restricted operation.
- Restricting
Service string - Name of the service restricting the operation.
- Operation
Name string - Name of the restricted operation.
- Restricting
Service string - Name of the service restricting the operation.
- operation
Name String - Name of the restricted operation.
- restricting
Service String - Name of the service restricting the operation.
- operation
Name string - Name of the restricted operation.
- restricting
Service string - Name of the service restricting the operation.
- operation_
name str - Name of the restricted operation.
- restricting_
service str - Name of the service restricting the operation.
- operation
Name String - Name of the restricted operation.
- restricting
Service String - Name of the service restricting the operation.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.