1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Oda
  5. OdaInstance
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Oda.OdaInstance

Explore with Pulumi AI

This resource provides the Oda Instance resource in Oracle Cloud Infrastructure Digital Assistant service.

Starts an asynchronous job to create a Digital Assistant instance.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestId}.

Example Usage

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

const testOdaInstance = new oci.oda.OdaInstance("test_oda_instance", {
    compartmentId: compartmentId,
    shapeName: "DEVELOPMENT",
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: odaInstanceDescription,
    displayName: odaInstanceDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
    identityDomain: odaInstanceIdentityDomain,
    isRoleBasedAccess: odaInstanceIsRoleBasedAccess,
});
Copy
import pulumi
import pulumi_oci as oci

test_oda_instance = oci.oda.OdaInstance("test_oda_instance",
    compartment_id=compartment_id,
    shape_name="DEVELOPMENT",
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=oda_instance_description,
    display_name=oda_instance_display_name,
    freeform_tags={
        "bar-key": "value",
    },
    identity_domain=oda_instance_identity_domain,
    is_role_based_access=oda_instance_is_role_based_access)
Copy
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.NewOdaInstance(ctx, "test_oda_instance", &oda.OdaInstanceArgs{
			CompartmentId: pulumi.Any(compartmentId),
			ShapeName:     pulumi.String("DEVELOPMENT"),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(odaInstanceDescription),
			DisplayName: pulumi.Any(odaInstanceDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IdentityDomain:    pulumi.Any(odaInstanceIdentityDomain),
			IsRoleBasedAccess: pulumi.Any(odaInstanceIsRoleBasedAccess),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOdaInstance = new Oci.Oda.OdaInstance("test_oda_instance", new()
    {
        CompartmentId = compartmentId,
        ShapeName = "DEVELOPMENT",
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = odaInstanceDescription,
        DisplayName = odaInstanceDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IdentityDomain = odaInstanceIdentityDomain,
        IsRoleBasedAccess = odaInstanceIsRoleBasedAccess,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Oda.OdaInstance;
import com.pulumi.oci.Oda.OdaInstanceArgs;
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) {
        var testOdaInstance = new OdaInstance("testOdaInstance", OdaInstanceArgs.builder()
            .compartmentId(compartmentId)
            .shapeName("DEVELOPMENT")
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(odaInstanceDescription)
            .displayName(odaInstanceDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .identityDomain(odaInstanceIdentityDomain)
            .isRoleBasedAccess(odaInstanceIsRoleBasedAccess)
            .build());

    }
}
Copy
resources:
  testOdaInstance:
    type: oci:Oda:OdaInstance
    name: test_oda_instance
    properties:
      compartmentId: ${compartmentId}
      shapeName: DEVELOPMENT
      definedTags:
        foo-namespace.bar-key: value
      description: ${odaInstanceDescription}
      displayName: ${odaInstanceDisplayName}
      freeformTags:
        bar-key: value
      identityDomain: ${odaInstanceIdentityDomain}
      isRoleBasedAccess: ${odaInstanceIsRoleBasedAccess}
Copy

Create OdaInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OdaInstance(name: string, args: OdaInstanceArgs, opts?: CustomResourceOptions);
@overload
def OdaInstance(resource_name: str,
                args: OdaInstanceArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OdaInstance(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                shape_name: Optional[str] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                identity_domain: Optional[str] = None,
                is_role_based_access: Optional[bool] = None,
                state: Optional[str] = None)
func NewOdaInstance(ctx *Context, name string, args OdaInstanceArgs, opts ...ResourceOption) (*OdaInstance, error)
public OdaInstance(string name, OdaInstanceArgs args, CustomResourceOptions? opts = null)
public OdaInstance(String name, OdaInstanceArgs args)
public OdaInstance(String name, OdaInstanceArgs args, CustomResourceOptions options)
type: oci:Oda:OdaInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OdaInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OdaInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OdaInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OdaInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OdaInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var odaInstanceResource = new Oci.Oda.OdaInstance("odaInstanceResource", new()
{
    CompartmentId = "string",
    ShapeName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IdentityDomain = "string",
    IsRoleBasedAccess = false,
    State = "string",
});
Copy
example, err := Oda.NewOdaInstance(ctx, "odaInstanceResource", &Oda.OdaInstanceArgs{
	CompartmentId: pulumi.String("string"),
	ShapeName:     pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IdentityDomain:    pulumi.String("string"),
	IsRoleBasedAccess: pulumi.Bool(false),
	State:             pulumi.String("string"),
})
Copy
var odaInstanceResource = new OdaInstance("odaInstanceResource", OdaInstanceArgs.builder()
    .compartmentId("string")
    .shapeName("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .identityDomain("string")
    .isRoleBasedAccess(false)
    .state("string")
    .build());
Copy
oda_instance_resource = oci.oda.OdaInstance("odaInstanceResource",
    compartment_id="string",
    shape_name="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    identity_domain="string",
    is_role_based_access=False,
    state="string")
Copy
const odaInstanceResource = new oci.oda.OdaInstance("odaInstanceResource", {
    compartmentId: "string",
    shapeName: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    identityDomain: "string",
    isRoleBasedAccess: false,
    state: "string",
});
Copy
type: oci:Oda:OdaInstance
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    identityDomain: string
    isRoleBasedAccess: false
    shapeName: string
    state: string
Copy

OdaInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OdaInstance resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) Identifier of the compartment.
ShapeName
This property is required.
Changes to this property will trigger replacement.
string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DefinedTags Dictionary<string, string>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Description of the Digital Assistant instance.
DisplayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
IdentityDomain Changes to this property will trigger replacement. 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.
IsRoleBasedAccess Changes to this property will trigger replacement. 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)
State string
The current state of the Digital Assistant instance.
CompartmentId This property is required. string
(Updatable) Identifier of the compartment.
ShapeName
This property is required.
Changes to this property will trigger replacement.
string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DefinedTags map[string]string
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Description of the Digital Assistant instance.
DisplayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
IdentityDomain Changes to this property will trigger replacement. 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.
IsRoleBasedAccess Changes to this property will trigger replacement. 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)
State string
The current state of the Digital Assistant instance.
compartmentId This property is required. String
(Updatable) Identifier of the compartment.
shapeName
This property is required.
Changes to this property will trigger replacement.
String

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

definedTags Map<String,String>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Description of the Digital Assistant instance.
displayName String
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
identityDomain Changes to this property will trigger replacement. 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.
isRoleBasedAccess Changes to this property will trigger replacement. 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)
state String
The current state of the Digital Assistant instance.
compartmentId This property is required. string
(Updatable) Identifier of the compartment.
shapeName
This property is required.
Changes to this property will trigger replacement.
string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

definedTags {[key: string]: string}
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description string
(Updatable) Description of the Digital Assistant instance.
displayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
identityDomain Changes to this property will trigger replacement. 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.
isRoleBasedAccess Changes to this property will trigger replacement. 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)
state string
The current state of the Digital Assistant instance.
compartment_id This property is required. str
(Updatable) Identifier of the compartment.
shape_name
This property is required.
Changes to this property will trigger replacement.
str

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

defined_tags Mapping[str, str]
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description str
(Updatable) Description of the Digital Assistant instance.
display_name str
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
identity_domain Changes to this property will trigger replacement. 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.
is_role_based_access Changes to this property will trigger replacement. 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)
state str
The current state of the Digital Assistant instance.
compartmentId This property is required. String
(Updatable) Identifier of the compartment.
shapeName
This property is required.
Changes to this property will trigger replacement.
String

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

definedTags Map<String>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Description of the Digital Assistant instance.
displayName String
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
identityDomain Changes to this property will trigger replacement. 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.
isRoleBasedAccess Changes to this property will trigger replacement. 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)
state String
The current state of the Digital Assistant instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the OdaInstance resource produces the following output properties:

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.
ConnectorUrl string
URL for the connector's endpoint.
Id string
The provider-assigned unique ID for this managed resource.
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.
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.
LifecycleSubState string
The current sub-state of the Digital Assistant instance.
RestrictedOperations List<OdaInstanceRestrictedOperation>
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
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.
ConnectorUrl string
URL for the connector's endpoint.
Id string
The provider-assigned unique ID for this managed resource.
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.
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.
LifecycleSubState string
The current sub-state of the Digital Assistant instance.
RestrictedOperations []OdaInstanceRestrictedOperation
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
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.
connectorUrl String
URL for the connector's endpoint.
id String
The provider-assigned unique ID for this managed resource.
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.
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.
lifecycleSubState String
The current sub-state of the Digital Assistant instance.
restrictedOperations List<InstanceRestrictedOperation>
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
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.
connectorUrl string
URL for the connector's endpoint.
id string
The provider-assigned unique ID for this managed resource.
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.
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.
lifecycleSubState string
The current sub-state of the Digital Assistant instance.
restrictedOperations OdaInstanceRestrictedOperation[]
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
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.
connector_url str
URL for the connector's endpoint.
id str
The provider-assigned unique ID for this managed resource.
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.
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.
lifecycle_sub_state str
The current sub-state of the Digital Assistant instance.
restricted_operations Sequence[oda.OdaInstanceRestrictedOperation]
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
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.
connectorUrl String
URL for the connector's endpoint.
id String
The provider-assigned unique ID for this managed resource.
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.
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.
lifecycleSubState String
The current sub-state of the Digital Assistant instance.
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.
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.

Look up Existing OdaInstance Resource

Get an existing OdaInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OdaInstanceState, opts?: CustomResourceOptions): OdaInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attachment_ids: Optional[Sequence[str]] = None,
        attachment_types: Optional[Sequence[str]] = None,
        compartment_id: Optional[str] = None,
        connector_url: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        identity_app_console_url: Optional[str] = None,
        identity_app_guid: Optional[str] = None,
        identity_domain: Optional[str] = None,
        imported_package_ids: Optional[Sequence[str]] = None,
        imported_package_names: Optional[Sequence[str]] = None,
        is_role_based_access: Optional[bool] = None,
        lifecycle_sub_state: Optional[str] = None,
        restricted_operations: Optional[Sequence[_oda.OdaInstanceRestrictedOperationArgs]] = None,
        shape_name: Optional[str] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        web_app_url: Optional[str] = None) -> OdaInstance
func GetOdaInstance(ctx *Context, name string, id IDInput, state *OdaInstanceState, opts ...ResourceOption) (*OdaInstance, error)
public static OdaInstance Get(string name, Input<string> id, OdaInstanceState? state, CustomResourceOptions? opts = null)
public static OdaInstance get(String name, Output<String> id, OdaInstanceState state, CustomResourceOptions options)
resources:  _:    type: oci:Oda:OdaInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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
(Updatable) Identifier of the compartment.
ConnectorUrl string
URL for the connector's endpoint.
DefinedTags Dictionary<string, string>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Description of the Digital Assistant instance.
DisplayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
RestrictedOperations List<OdaInstanceRestrictedOperation>
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
ShapeName Changes to this property will trigger replacement. string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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
(Updatable) Identifier of the compartment.
ConnectorUrl string
URL for the connector's endpoint.
DefinedTags map[string]string
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string
(Updatable) Description of the Digital Assistant instance.
DisplayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
RestrictedOperations []OdaInstanceRestrictedOperationArgs
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
ShapeName Changes to this property will trigger replacement. string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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
(Updatable) Identifier of the compartment.
connectorUrl String
URL for the connector's endpoint.
definedTags Map<String,String>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Description of the Digital Assistant instance.
displayName String
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
restrictedOperations List<InstanceRestrictedOperation>
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
shapeName Changes to this property will trigger replacement. String

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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
(Updatable) Identifier of the compartment.
connectorUrl string
URL for the connector's endpoint.
definedTags {[key: string]: string}
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description string
(Updatable) Description of the Digital Assistant instance.
displayName string
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
restrictedOperations OdaInstanceRestrictedOperation[]
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
shapeName Changes to this property will trigger replacement. string

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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
(Updatable) Identifier of the compartment.
connector_url str
URL for the connector's endpoint.
defined_tags Mapping[str, str]
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description str
(Updatable) Description of the Digital Assistant instance.
display_name str
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
restricted_operations Sequence[oda.OdaInstanceRestrictedOperationArgs]
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
shape_name Changes to this property will trigger replacement. str

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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
(Updatable) Identifier of the compartment.
connectorUrl String
URL for the connector's endpoint.
definedTags Map<String>
(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) Description of the Digital Assistant instance.
displayName String
(Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
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 Changes to this property will trigger replacement. String

Shape or size of the instance.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

OdaInstanceRestrictedOperation
, OdaInstanceRestrictedOperationArgs

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.

Import

OdaInstances can be imported using the id, e.g.

$ pulumi import oci:Oda/odaInstance:OdaInstance test_oda_instance "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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