import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the External Database Connector resource in Oracle Cloud Infrastructure Database service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/database/latest/ExternalDatabaseConnector * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/database * * Creates a new external database connector. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testExternalDatabaseConnector = new oci.database.ExternalDatabaseConnector("test_external_database_connector", { * connectionCredentials: { * credentialName: externalDatabaseConnectorConnectionCredentialsCredentialName, * credentialType: externalDatabaseConnectorConnectionCredentialsCredentialType, * password: externalDatabaseConnectorConnectionCredentialsPassword, * role: externalDatabaseConnectorConnectionCredentialsRole, * sslSecretId: testSecret.id, * username: externalDatabaseConnectorConnectionCredentialsUsername, * }, * connectionString: { * hostname: externalDatabaseConnectorConnectionStringHostname, * port: Number(externalDatabaseConnectorConnectionStringPort), * protocol: externalDatabaseConnectorConnectionStringProtocol, * service: externalDatabaseConnectorConnectionStringService, * }, * connectorAgentId: testConnectorAgent.id, * displayName: externalDatabaseConnectorDisplayName, * externalDatabaseId: testDatabase.id, * connectorType: externalDatabaseConnectorConnectorType, * definedTags: externalDatabaseConnectorDefinedTags, * freeformTags: { * Department: "Finance", * }, * }); * ``` * * ## Import * * ExternalDatabaseConnectors can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Database/externalDatabaseConnector:ExternalDatabaseConnector test_external_database_connector "id" * ``` */ export declare class ExternalDatabaseConnector extends pulumi.CustomResource { /** * Get an existing ExternalDatabaseConnector 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?: ExternalDatabaseConnectorState, opts?: pulumi.CustomResourceOptions): ExternalDatabaseConnector; /** * Returns true if the given object is an instance of ExternalDatabaseConnector. 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 ExternalDatabaseConnector; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector crendentials. */ readonly connectionCredentials: pulumi.Output; /** * The status of connectivity to the external database. */ readonly connectionStatus: pulumi.Output; /** * (Updatable) The Oracle AI Database connection string. */ readonly connectionString: pulumi.Output; /** * The ID of the agent used for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ readonly connectorAgentId: pulumi.Output; /** * (Updatable) The type of connector used by the external database resource. */ readonly connectorType: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The user-friendly name for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. */ readonly displayName: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database resource. */ readonly externalDatabaseId: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` * * ** 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 freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * Additional information about the current lifecycle state. */ readonly lifecycleDetails: pulumi.Output; /** * The current lifecycle state of the external database connector resource. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the `connectionStatus` of this external connector was last updated. */ readonly timeConnectionStatusLastUpdated: pulumi.Output; /** * The date and time the external connector was created. */ readonly timeCreated: pulumi.Output; /** * Create a ExternalDatabaseConnector 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: ExternalDatabaseConnectorArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ExternalDatabaseConnector resources. */ export interface ExternalDatabaseConnectorState { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId?: pulumi.Input; /** * (Updatable) Credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector crendentials. */ connectionCredentials?: pulumi.Input; /** * The status of connectivity to the external database. */ connectionStatus?: pulumi.Input; /** * (Updatable) The Oracle AI Database connection string. */ connectionString?: pulumi.Input; /** * The ID of the agent used for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ connectorAgentId?: pulumi.Input; /** * (Updatable) The type of connector used by the external database resource. */ connectorType?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The user-friendly name for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. */ displayName?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database resource. */ externalDatabaseId?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` * * ** 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 */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Additional information about the current lifecycle state. */ lifecycleDetails?: pulumi.Input; /** * The current lifecycle state of the external database connector resource. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the `connectionStatus` of this external connector was last updated. */ timeConnectionStatusLastUpdated?: pulumi.Input; /** * The date and time the external connector was created. */ timeCreated?: pulumi.Input; } /** * The set of arguments for constructing a ExternalDatabaseConnector resource. */ export interface ExternalDatabaseConnectorArgs { /** * (Updatable) Credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector crendentials. */ connectionCredentials: pulumi.Input; /** * (Updatable) The Oracle AI Database connection string. */ connectionString: pulumi.Input; /** * The ID of the agent used for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ connectorAgentId: pulumi.Input; /** * (Updatable) The type of connector used by the external database resource. */ connectorType?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The user-friendly name for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). The name does not have to be unique. */ displayName: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database resource. */ externalDatabaseId: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` * * ** 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 */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=externalDatabaseConnector.d.ts.map