Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.32.0 published on Wednesday, Jul 20, 2022 by Pulumi

DocumentAiProcessor

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:

Example Usage

Documentai Processor

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var processor = new Gcp.EssentialContacts.DocumentAiProcessor("processor", new Gcp.EssentialContacts.DocumentAiProcessorArgs
        {
            DisplayName = "test-processor",
            Location = "us",
            Type = "OCR_PROCESSOR",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/essentialcontacts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := essentialcontacts.NewDocumentAiProcessor(ctx, "processor", &essentialcontacts.DocumentAiProcessorArgs{
			DisplayName: pulumi.String("test-processor"),
			Location:    pulumi.String("us"),
			Type:        pulumi.String("OCR_PROCESSOR"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var processor = new DocumentAiProcessor("processor", DocumentAiProcessorArgs.builder()        
            .displayName("test-processor")
            .location("us")
            .type("OCR_PROCESSOR")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

processor = gcp.essentialcontacts.DocumentAiProcessor("processor",
    display_name="test-processor",
    location="us",
    type="OCR_PROCESSOR")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const processor = new gcp.essentialcontacts.DocumentAiProcessor("processor", {
    displayName: "test-processor",
    location: "us",
    type: "OCR_PROCESSOR",
});
resources:
  processor:
    type: gcp:essentialcontacts:DocumentAiProcessor
    properties:
      displayName: test-processor
      location: us
      type: OCR_PROCESSOR

Create a DocumentAiProcessor Resource

new DocumentAiProcessor(name: string, args: DocumentAiProcessorArgs, opts?: CustomResourceOptions);
@overload
def DocumentAiProcessor(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        display_name: Optional[str] = None,
                        kms_key_name: Optional[str] = None,
                        location: Optional[str] = None,
                        project: Optional[str] = None,
                        type: Optional[str] = None)
@overload
def DocumentAiProcessor(resource_name: str,
                        args: DocumentAiProcessorArgs,
                        opts: Optional[ResourceOptions] = None)
func NewDocumentAiProcessor(ctx *Context, name string, args DocumentAiProcessorArgs, opts ...ResourceOption) (*DocumentAiProcessor, error)
public DocumentAiProcessor(string name, DocumentAiProcessorArgs args, CustomResourceOptions? opts = null)
public DocumentAiProcessor(String name, DocumentAiProcessorArgs args)
public DocumentAiProcessor(String name, DocumentAiProcessorArgs args, CustomResourceOptions options)
type: gcp:essentialcontacts:DocumentAiProcessor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DocumentAiProcessorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DocumentAiProcessorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DocumentAiProcessorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DocumentAiProcessorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DocumentAiProcessorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DocumentAiProcessor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DocumentAiProcessor resource accepts the following input properties:

DisplayName string

The display name. Must be unique.

Location string

The location of the resource.

Type string

The type of processor. For possible types see the official list

KmsKeyName string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

DisplayName string

The display name. Must be unique.

Location string

The location of the resource.

Type string

The type of processor. For possible types see the official list

KmsKeyName string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName String

The display name. Must be unique.

location String

The location of the resource.

type String

The type of processor. For possible types see the official list

kmsKeyName String

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

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName string

The display name. Must be unique.

location string

The location of the resource.

type string

The type of processor. For possible types see the official list

kmsKeyName string

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

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

display_name str

The display name. Must be unique.

location str

The location of the resource.

type str

The type of processor. For possible types see the official list

kms_key_name str

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

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName String

The display name. Must be unique.

location String

The location of the resource.

type String

The type of processor. For possible types see the official list

kmsKeyName String

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

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the DocumentAiProcessor resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the processor.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the processor.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the processor.

id string

The provider-assigned unique ID for this managed resource.

name string

The resource name of the processor.

id str

The provider-assigned unique ID for this managed resource.

name str

The resource name of the processor.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the processor.

Look up an Existing DocumentAiProcessor Resource

Get an existing DocumentAiProcessor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DocumentAiProcessorState, opts?: CustomResourceOptions): DocumentAiProcessor
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        kms_key_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        type: Optional[str] = None) -> DocumentAiProcessor
func GetDocumentAiProcessor(ctx *Context, name string, id IDInput, state *DocumentAiProcessorState, opts ...ResourceOption) (*DocumentAiProcessor, error)
public static DocumentAiProcessor Get(string name, Input<string> id, DocumentAiProcessorState? state, CustomResourceOptions? opts = null)
public static DocumentAiProcessor get(String name, Output<String> id, DocumentAiProcessorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DisplayName string

The display name. Must be unique.

KmsKeyName string

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

Location string

The location of the resource.

Name string

The resource name of the processor.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Type string

The type of processor. For possible types see the official list

DisplayName string

The display name. Must be unique.

KmsKeyName string

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

Location string

The location of the resource.

Name string

The resource name of the processor.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Type string

The type of processor. For possible types see the official list

displayName String

The display name. Must be unique.

kmsKeyName String

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

location String

The location of the resource.

name String

The resource name of the processor.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type String

The type of processor. For possible types see the official list

displayName string

The display name. Must be unique.

kmsKeyName string

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

location string

The location of the resource.

name string

The resource name of the processor.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type string

The type of processor. For possible types see the official list

display_name str

The display name. Must be unique.

kms_key_name str

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

location str

The location of the resource.

name str

The resource name of the processor.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type str

The type of processor. For possible types see the official list

displayName String

The display name. Must be unique.

kmsKeyName String

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

location String

The location of the resource.

name String

The resource name of the processor.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type String

The type of processor. For possible types see the official list

Import

Processor can be imported using any of these accepted formats

 $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default projects/{{project}}/locations/{{location}}/processors/{{name}}
 $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{project}}/{{location}}/{{name}}
 $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{location}}/{{name}}

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.