import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Oda Instance resource in Oracle Cloud Infrastructure Digital Assistant service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/digital-assistant/latest/OdaInstance * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/oracle_digital_assistant * * 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 * * ```typescript * 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 === "true", * }); * ``` * * ## Import * * OdaInstances can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Oda/odaInstance:OdaInstance test_oda_instance "id" * ``` */ export declare class OdaInstance extends pulumi.CustomResource { /** * Get an existing OdaInstance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: OdaInstanceState, opts?: pulumi.CustomResourceOptions): OdaInstance; /** * Returns true if the given object is an instance of OdaInstance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is OdaInstance; /** * A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ readonly attachmentIds: pulumi.Output; /** * A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. */ readonly attachmentTypes: pulumi.Output; /** * (Updatable) Identifier of the compartment. */ readonly compartmentId: pulumi.Output; /** * URL for the connector's endpoint. */ readonly connectorUrl: pulumi.Output; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Description of the Digital Assistant instance. */ readonly description: pulumi.Output; /** * (Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. */ readonly displayName: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: 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. */ readonly identityAppConsoleUrl: pulumi.Output; /** * 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. */ readonly identityAppGuid: pulumi.Output; /** * 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. */ readonly identityDomain: pulumi.Output; /** * A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. */ readonly importedPackageIds: pulumi.Output; /** * A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. */ readonly importedPackageNames: pulumi.Output; /** * 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) */ readonly isRoleBasedAccess: pulumi.Output; /** * The current sub-state of the Digital Assistant instance. */ readonly lifecycleSubState: pulumi.Output; /** * A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ readonly restrictedOperations: pulumi.Output; /** * 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 */ readonly shapeName: pulumi.Output; /** * The current state of the Digital Assistant instance. */ readonly state: pulumi.Output; /** * A message that describes the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state. */ readonly stateMessage: pulumi.Output; /** * When the Digital Assistant instance was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ readonly timeCreated: pulumi.Output; /** * When the Digital Assistance instance was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ readonly timeUpdated: pulumi.Output; /** * URL for the Digital Assistant web application that's associated with the instance. */ readonly webAppUrl: pulumi.Output; /** * Create a OdaInstance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: OdaInstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OdaInstance resources. */ export interface OdaInstanceState { /** * A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ attachmentIds?: pulumi.Input[] | undefined>; /** * A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. */ attachmentTypes?: pulumi.Input[] | undefined>; /** * (Updatable) Identifier of the compartment. */ compartmentId?: pulumi.Input; /** * URL for the connector's endpoint. */ connectorUrl?: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Description of the Digital Assistant instance. */ description?: pulumi.Input; /** * (Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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. */ identityAppConsoleUrl?: pulumi.Input; /** * 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. */ identityAppGuid?: pulumi.Input; /** * 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. */ identityDomain?: pulumi.Input; /** * A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. */ importedPackageIds?: pulumi.Input[] | undefined>; /** * A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. */ importedPackageNames?: pulumi.Input[] | undefined>; /** * 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) */ isRoleBasedAccess?: pulumi.Input; /** * The current sub-state of the Digital Assistant instance. */ lifecycleSubState?: pulumi.Input; /** * A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ restrictedOperations?: pulumi.Input[] | undefined>; /** * 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 */ shapeName?: pulumi.Input; /** * The current state of the Digital Assistant instance. */ state?: pulumi.Input; /** * A message that describes the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state. */ stateMessage?: pulumi.Input; /** * When the Digital Assistant instance was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated?: pulumi.Input; /** * When the Digital Assistance instance was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated?: pulumi.Input; /** * URL for the Digital Assistant web application that's associated with the instance. */ webAppUrl?: pulumi.Input; } /** * The set of arguments for constructing a OdaInstance resource. */ export interface OdaInstanceArgs { /** * (Updatable) Identifier of the compartment. */ compartmentId: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Description of the Digital Assistant instance. */ description?: pulumi.Input; /** * (Updatable) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * 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. */ identityDomain?: pulumi.Input; /** * 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) */ isRoleBasedAccess?: pulumi.Input; /** * 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 */ shapeName: pulumi.Input; /** * The current state of the Digital Assistant instance. */ state?: pulumi.Input; } //# sourceMappingURL=odaInstance.d.ts.map