oci_oda_oda_instance

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

resource "oci_oda_oda_instance" "test_oda_instance" {
	#Required
	compartment_id = var.compartment_id
	shape_name = "DEVELOPMENT"

	#Optional
	defined_tags = {"foo-namespace.bar-key"= "value"}
	description = var.oda_instance_description
	display_name = var.oda_instance_display_name
	freeform_tags = {"bar-key"= "value"}
	identity_domain = var.oda_instance_identity_domain
	is_role_based_access = var.oda_instance_is_role_based_access
}

Argument Reference

The following arguments are supported:

• compartment_id - (Required) (Updatable) Identifier of the compartment.
• defined_tags - (Optional) (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
• description - (Optional) (Updatable) Description of the Digital Assistant instance.
• display_name - (Optional) (Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
• freeform_tags - (Optional) (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
• identity_domain - (Optional) 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 - (Optional) 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)
• shape_name - (Required) 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

Attributes Reference

The following attributes are exported:

• attachment_ids - A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
• attachment_types - A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
• compartment_id - Identifier of the compartment that the instance belongs to.
• connector_url - URL for the connector’s endpoint.
• defined_tags - Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
• description - Description of the Digital Assistant instance.
• display_name - User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
• freeform_tags - Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
• id - Unique immutable identifier that was assigned when the instance was created.
• identity_app_console_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_guid - 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 - 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 - A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
• imported_package_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_based_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_state - The current sub-state of the Digital Assistant instance.
• restricted_operations - A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
  • operation_name - Name of the restricted operation.
  • restricting_service - Name of the service restricting the operation.
• shape_name - Shape or size of the instance.
• state - The current state of the Digital Assistant instance.
• state_message - 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 - When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
• time_updated - When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
• web_app_url - URL for the Digital Assistant web application that’s associated with the instance.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 40 minutes), when creating the Oda Instance * update - (Defaults to 40 minutes), when updating the Oda Instance * delete - (Defaults to 20 minutes), when destroying the Oda Instance

Import

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

$ terraform import oci_oda_oda_instance.test_oda_instance "id"