Data Source: oci_oda_oda_instances
This data source provides the list of Oda Instances in Oracle Cloud Infrastructure Digital Assistant service.
Returns a page of Digital Assistant instances that belong to the specified compartment.
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header’s value as the page
query parameter.
Example Usage
data "oci_oda_oda_instances" "test_oda_instances" {
#Required
compartment_id = var.compartment_id
#Optional
display_name = var.oda_instance_display_name
state = var.oda_instance_state
}
Argument Reference
The following arguments are supported:
compartment_id
- (Required) List the Digital Assistant instances that belong to this compartment.display_name
- (Optional) List only the information for the Digital Assistant instance with this user-friendly name. These names don’t have to be unique and may change. Example:My new resource
state
- (Optional) List only the Digital Assistant instances that are in this lifecycle state.
Attributes Reference
The following attributes are exported:
oda_instances
- The list of oda_instances.
OdaInstance 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 theFAILED
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.