import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Index resource in Oracle Cloud Infrastructure NoSQL Database service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/nosql-database/latest/Index * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/object_storage * * Create a new index on the table identified by tableNameOrId. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testIndex = new oci.nosql.Index("test_index", { * keys: [{ * columnName: indexKeysColumnName, * jsonFieldType: indexKeysJsonFieldType, * jsonPath: indexKeysJsonPath, * }], * name: indexName, * tableNameOrId: testTableNameOr.id, * compartmentId: compartmentId, * isIfNotExists: indexIsIfNotExists === "true", * }); * ``` * * ## Import * * Indexes can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Nosql/index:Index test_index "tables/{tableNameOrId}/indexes/{indexName}" * ``` */ export declare class Index extends pulumi.CustomResource { /** * Get an existing Index 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?: IndexState, opts?: pulumi.CustomResourceOptions): Index; /** * Returns true if the given object is an instance of Index. 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 Index; /** * The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId. */ readonly compartmentId: pulumi.Output; /** * If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error. */ readonly isIfNotExists: pulumi.Output; /** * A set of keys for a secondary index. */ readonly keys: pulumi.Output; /** * A message describing the current state in more detail. */ readonly lifecycleDetails: pulumi.Output; /** * Index name. */ readonly name: pulumi.Output; /** * The state of an index. */ readonly state: pulumi.Output; /** * the OCID of the table to which this index belongs. */ readonly tableId: pulumi.Output; /** * The name of the table to which this index belongs. */ readonly tableName: pulumi.Output; /** * A table name within the compartment, or a table OCID. * * ** IMPORTANT ** * Any change to a property that is not identified as "Updateable" will force the destruction and recreation of the resource with the new property values. */ readonly tableNameOrId: pulumi.Output; /** * Create a Index 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: IndexArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Index resources. */ export interface IndexState { /** * The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId. */ compartmentId?: pulumi.Input; /** * If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error. */ isIfNotExists?: pulumi.Input; /** * A set of keys for a secondary index. */ keys?: pulumi.Input[] | undefined>; /** * A message describing the current state in more detail. */ lifecycleDetails?: pulumi.Input; /** * Index name. */ name?: pulumi.Input; /** * The state of an index. */ state?: pulumi.Input; /** * the OCID of the table to which this index belongs. */ tableId?: pulumi.Input; /** * The name of the table to which this index belongs. */ tableName?: pulumi.Input; /** * A table name within the compartment, or a table OCID. * * ** IMPORTANT ** * Any change to a property that is not identified as "Updateable" will force the destruction and recreation of the resource with the new property values. */ tableNameOrId?: pulumi.Input; } /** * The set of arguments for constructing a Index resource. */ export interface IndexArgs { /** * The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId. */ compartmentId?: pulumi.Input; /** * If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error. */ isIfNotExists?: pulumi.Input; /** * A set of keys for a secondary index. */ keys: pulumi.Input[]>; /** * Index name. */ name?: pulumi.Input; /** * A table name within the compartment, or a table OCID. * * ** IMPORTANT ** * Any change to a property that is not identified as "Updateable" will force the destruction and recreation of the resource with the new property values. */ tableNameOrId: pulumi.Input; } //# sourceMappingURL=index_.d.ts.map