Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Oda.getOdaInstance

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

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:

OdaInstanceId string: Unique Digital Assistant instance identifier.

OdaInstanceId string: Unique Digital Assistant instance identifier.

odaInstanceId String: Unique Digital Assistant instance identifier.

odaInstanceId string: Unique Digital Assistant instance identifier.

oda_instance_id str: Unique Digital Assistant instance identifier.

odaInstanceId String: Unique Digital Assistant instance identifier.

getOdaInstance Result

The following output properties are available:

AttachmentIds List<string>: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
AttachmentTypes List<string>: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
CompartmentId string: Identifier of the compartment that the instance belongs to.
ConnectorUrl string: URL for the connector's endpoint.
DefinedTags 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.
DisplayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
FreeformTags 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.
IdentityAppConsoleUrl string: 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.
IdentityAppGuid string: 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.
IdentityDomain 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.
ImportedPackageIds List<string>: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
ImportedPackageNames List<string>: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
IsRoleBasedAccess bool: 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)
LifecycleSubState string: The current sub-state of the Digital Assistant instance.
OdaInstanceId string
RestrictedOperations List<GetOdaInstanceRestrictedOperation>: A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
ShapeName string: Shape or size of the instance.
State string: The current state of the Digital Assistant instance.
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.

AttachmentIds []string: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
AttachmentTypes []string: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
CompartmentId string: Identifier of the compartment that the instance belongs to.
ConnectorUrl string: URL for the connector's endpoint.
DefinedTags 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.
DisplayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
FreeformTags 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.
IdentityAppConsoleUrl string: 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.
IdentityAppGuid string: 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.
IdentityDomain 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.
ImportedPackageIds []string: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
ImportedPackageNames []string: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
IsRoleBasedAccess bool: 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)
LifecycleSubState string: The current sub-state of the Digital Assistant instance.
OdaInstanceId string
RestrictedOperations []GetOdaInstanceRestrictedOperation: A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
ShapeName string: Shape or size of the instance.
State string: The current state of the Digital Assistant instance.
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.

attachmentIds List<String>: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
attachmentTypes List<String>: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
compartmentId String: Identifier of the compartment that the instance belongs to.
connectorUrl String: URL for the connector's endpoint.
definedTags 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.
displayName String: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
freeformTags 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.
identityAppConsoleUrl String: 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.
identityAppGuid String: 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.
identityDomain 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.
importedPackageIds List<String>: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
importedPackageNames List<String>: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
isRoleBasedAccess Boolean: 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)
lifecycleSubState String: The current sub-state of the Digital Assistant instance.
odaInstanceId String
restrictedOperations List<GetInstanceRestrictedOperation>: A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
shapeName String: Shape or size of the instance.
state String: The current state of the Digital Assistant instance.
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.

attachmentIds string[]: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
attachmentTypes string[]: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
compartmentId string: Identifier of the compartment that the instance belongs to.
connectorUrl string: URL for the connector's endpoint.
definedTags {[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.
displayName string: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
freeformTags {[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.
identityAppConsoleUrl string: 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.
identityAppGuid string: 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.
identityDomain 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.
importedPackageIds string[]: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
importedPackageNames string[]: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
isRoleBasedAccess boolean: 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)
lifecycleSubState string: The current sub-state of the Digital Assistant instance.
odaInstanceId string
restrictedOperations GetOdaInstanceRestrictedOperation[]: A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
shapeName string: Shape or size of the instance.
state string: The current state of the Digital Assistant instance.
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.

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.
defined_tags Mapping[str, str]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description str: 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.
freeform_tags 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_console_url str: 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_guid str: 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_ids Sequence[str]: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
imported_package_names Sequence[str]: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
is_role_based_access bool: 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_state str: The current sub-state of the Digital Assistant instance.
oda_instance_id str
restricted_operations Sequence[oda.GetOdaInstanceRestrictedOperation]: 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_url str: URL for the Digital Assistant web application that's associated with the instance.

attachmentIds List<String>: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
attachmentTypes List<String>: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
compartmentId String: Identifier of the compartment that the instance belongs to.
connectorUrl String: URL for the connector's endpoint.
definedTags 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.
displayName String: User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
freeformTags 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.
identityAppConsoleUrl String: 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.
identityAppGuid String: 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.
identityDomain 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.
importedPackageIds List<String>: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
importedPackageNames List<String>: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
isRoleBasedAccess Boolean: 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)
lifecycleSubState String: The current sub-state of the Digital Assistant instance.
odaInstanceId String
restrictedOperations 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.
shapeName String: Shape or size of the instance.
state String: The current state of the Digital Assistant instance.
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.

Supporting Types

GetOdaInstanceRestrictedOperation

OperationName string: Name of the restricted operation.
RestrictingService string: Name of the service restricting the operation.

OperationName string: Name of the restricted operation.
RestrictingService string: Name of the service restricting the operation.

operationName String: Name of the restricted operation.
restrictingService String: Name of the service restricting the operation.

operationName string: Name of the restricted operation.
restrictingService 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.

operationName String: Name of the restricted operation.
restrictingService 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.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.Oda.getOdaInstance

On this page

On this page

Example Usage

Using getOdaInstance

getOdaInstance Result

Supporting Types

GetOdaInstanceRestrictedOperation

Package Details

On this page

On this page