pulumi-aws-kotlin/com.pulumi.aws.comprehend.kotlin/DocumentClassifier

DocumentClassifier

class DocumentClassifier : KotlinCustomResource

Resource for managing an AWS Comprehend Document Classifier.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketObjectv2;
import com.pulumi.aws.comprehend.DocumentClassifier;
import com.pulumi.aws.comprehend.DocumentClassifierArgs;
import com.pulumi.aws.comprehend.inputs.DocumentClassifierInputDataConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var documents = new BucketObjectv2("documents");
        var example = new DocumentClassifier("example", DocumentClassifierArgs.builder()
            .dataAccessRoleArn(aws_iam_role.example().arn())
            .languageCode("en")
            .inputDataConfig(DocumentClassifierInputDataConfigArgs.builder()
                .s3Uri(documents.id().applyValue(id -> String.format("s3://%s/%s", aws_s3_bucket.test().bucket(),id)))
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(aws_iam_role_policy.example())
                .build());
        var entities = new BucketObjectv2("entities");
    }
}
Content copied to clipboard

Import

Comprehend Document Classifier can be imported using the ARN, e.g.,

$ pulumi import aws:comprehend/documentClassifier:DocumentClassifier example arn:aws:comprehend:us-west-2:123456789012:document_classifier/example
Content copied to clipboard

Properties

Link copied to clipboard
val arn: Output<String>

ARN of the Document Classifier version.

Link copied to clipboard
val dataAccessRoleArn: Output<String>

The ARN for an IAM Role which allows Comprehend to read the training and testing data.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val inputDataConfig: Output<DocumentClassifierInputDataConfig>

Configuration for the training and testing data. See the input_data_config Configuration Block section below.

Link copied to clipboard
val languageCode: Output<String>

Two-letter language code for the language. One of en, es, fr, it, de, or pt.

Link copied to clipboard
val mode: Output<String>?

The document classification mode. One of MULTI_CLASS or MULTI_LABEL. MULTI_CLASS is also known as "Single Label" in the AWS Console.

Link copied to clipboard
val modelKmsKeyId: Output<String>?

KMS Key used to encrypt trained Document Classifiers. Can be a KMS Key ID or a KMS Key ARN.

Link copied to clipboard
val name: Output<String>

Name for the Document Classifier. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). The following arguments are optional:

Link copied to clipboard
val outputDataConfig: Output<DocumentClassifierOutputDataConfig>

Configuration for the output results of training. See the output_data_config Configuration Block section below.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<Map<String, String>>?

A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val versionName: Output<String>

Name for the version of the Document Classifier. Each version must have a unique name within the Document Classifier. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.

Link copied to clipboard
val versionNamePrefix: Output<String>

Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.

Link copied to clipboard
val volumeKmsKeyId: Output<String>?

KMS Key used to encrypt storage volumes during job processing. Can be a KMS Key ID or a KMS Key ARN.

Link copied to clipboard
val vpcConfig: Output<DocumentClassifierVpcConfig>?

Configuration parameters for VPC to contain Document Classifier resources. See the vpc_config Configuration Block section below.