Package software.amazon.awscdk.services.comprehend

Class CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.comprehend.CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty>

Enclosing interface:

CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty

@Stability(Stable)
public static final class CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty>

A builder for CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty	build()	Builds the configured instance.
CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.getKmsKeyId()
CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder	s3Uri(String s3Uri)	Sets the value of CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.getS3Uri()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

kmsKeyId

@Stability(Stable)
public CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.getKmsKeyId()

Parameters:

kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
• KMS Key Alias: "alias/ExampleAlias"
• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

Returns:

this

s3Uri

@Stability(Stable)
public CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.Builder s3Uri(String s3Uri)

Sets the value of CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty.getS3Uri()

Parameters:

s3Uri - When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz . It is a compressed archive that contains the confusion matrix.

Returns:

this

build

@Stability(Stable)
public CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty>

Returns:

a new instance of CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty

Throws:

NullPointerException - if any required attribute was not provided