Skip to content

googleDocumentAiProcessor

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:

Open in Cloud Shell

Example Usage - Documentai Processor

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.documentAiProcessor.DocumentAiProcessor(this, "processor", {
  display_name: "test-processor",
  location: "us",
  type: "OCR_PROCESSOR",
});

Argument Reference

The following arguments are supported:

  • type - (Required) The type of processor. For possible types see the official list

  • displayName - (Required) The display name. Must be unique.

  • location - (Required) The location of the resource.

  • kmsKeyName - (Optional) The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/locations/{{location}}/processors/{{name}}

  • name - The resource name of the processor.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

Processor can be imported using any of these accepted formats:

$ terraform import google_document_ai_processor.default projects/{{project}}/locations/{{location}}/processors/{{name}}
$ terraform import google_document_ai_processor.default {{project}}/{{location}}/{{name}}
$ terraform import google_document_ai_processor.default {{location}}/{{name}}

User Project Overrides

This resource supports User Project Overrides.