@pulumi/gcp/essentialcontacts/documentAiProcessor.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
 *
 * To get more information about Processor, see:
 *
 * * [API documentation](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations.processors)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/document-ai/docs/overview)
 *
 * ## Example Usage
 *
 * ### Documentai Processor
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const processor = new gcp.essentialcontacts.DocumentAiProcessor("processor", {
 *     location: "us",
 *     displayName: "test-processor",
 *     type: "OCR_PROCESSOR",
 * });
 * ```
 *
 * ## Import
 *
 * Processor can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/processors/{{name}}`
 *
 * * `{{project}}/{{location}}/{{name}}`
 *
 * * `{{location}}/{{name}}`
 *
 * When using the `pulumi import` command, Processor can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default projects/{{project}}/locations/{{location}}/processors/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{project}}/{{location}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{location}}/{{name}}
 * ```
 */
export declare class DocumentAiProcessor extends pulumi.CustomResource {
    /**
     * Get an existing DocumentAiProcessor 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<pulumi.ID>, state?: DocumentAiProcessorState, opts?: pulumi.CustomResourceOptions): DocumentAiProcessor;
    /**
     * Returns true if the given object is an instance of DocumentAiProcessor.  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 DocumentAiProcessor;
    /**
     * The display name. Must be unique.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
     */
    readonly kmsKeyName: pulumi.Output<string | undefined>;
    /**
     * The location of the resource.
     *
     *
     * - - -
     */
    readonly location: pulumi.Output<string>;
    /**
     * The resource name of the processor.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The type of processor. For possible types see the [official list](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations/fetchProcessorTypes#google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes)
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a DocumentAiProcessor 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: DocumentAiProcessorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DocumentAiProcessor resources.
 */
export interface DocumentAiProcessorState {
    /**
     * The display name. Must be unique.
     */
    displayName?: pulumi.Input<string>;
    /**
     * The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
     */
    kmsKeyName?: pulumi.Input<string>;
    /**
     * The location of the resource.
     *
     *
     * - - -
     */
    location?: pulumi.Input<string>;
    /**
     * The resource name of the processor.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The type of processor. For possible types see the [official list](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations/fetchProcessorTypes#google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes)
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DocumentAiProcessor resource.
 */
export interface DocumentAiProcessorArgs {
    /**
     * The display name. Must be unique.
     */
    displayName: pulumi.Input<string>;
    /**
     * The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
     */
    kmsKeyName?: pulumi.Input<string>;
    /**
     * The location of the resource.
     *
     *
     * - - -
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The type of processor. For possible types see the [official list](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations/fetchProcessorTypes#google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes)
     */
    type: pulumi.Input<string>;
}