Package software.amazon.awscdk.services.comprehend

Class CfnDocumentClassifier.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentClassifier>

Enclosing class:

CfnDocumentClassifier

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

A fluent builder for CfnDocumentClassifier.

Method Summary

Modifier and Type	Method	Description
CfnDocumentClassifier	build()
static CfnDocumentClassifier.Builder	create(software.constructs.Construct scope, String id)
CfnDocumentClassifier.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
CfnDocumentClassifier.Builder	documentClassifierName(String documentClassifierName)	The name of the document classifier.
CfnDocumentClassifier.Builder	inputDataConfig(IResolvable inputDataConfig)	Specifies the format and location of the input data for the job.
CfnDocumentClassifier.Builder	inputDataConfig(CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty inputDataConfig)	Specifies the format and location of the input data for the job.
CfnDocumentClassifier.Builder	languageCode(String languageCode)	The language of the input documents.
CfnDocumentClassifier.Builder	mode(String mode)	Indicates the mode in which the classifier will be trained.
CfnDocumentClassifier.Builder	modelKmsKeyId(String modelKmsKeyId)	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
CfnDocumentClassifier.Builder	modelPolicy(String modelPolicy)	The resource-based policy to attach to your custom document classifier model.
CfnDocumentClassifier.Builder	outputDataConfig(IResolvable outputDataConfig)	Provides output results configuration parameters for custom classifier jobs.
CfnDocumentClassifier.Builder	outputDataConfig(CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty outputDataConfig)	Provides output results configuration parameters for custom classifier jobs.
CfnDocumentClassifier.Builder	tags(List<? extends CfnTag> tags)	Tags to associate with the document classifier.
CfnDocumentClassifier.Builder	versionName(String versionName)	The version name given to the newly created classifier.
CfnDocumentClassifier.Builder	volumeKmsKeyId(String volumeKmsKeyId)	ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
CfnDocumentClassifier.Builder	vpcConfig(IResolvable vpcConfig)	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
CfnDocumentClassifier.Builder	vpcConfig(CfnDocumentClassifier.VpcConfigProperty vpcConfig)	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDocumentClassifier.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDocumentClassifier.Builder.

dataAccessRoleArn

@Stability(Stable)
public CfnDocumentClassifier.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-dataaccessrolearn

documentClassifierName

@Stability(Stable)
public CfnDocumentClassifier.Builder documentClassifierName(String documentClassifierName)

The name of the document classifier.

Parameters:

documentClassifierName - The name of the document classifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-documentclassifiername

inputDataConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder inputDataConfig(IResolvable inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig - Specifies the format and location of the input data for the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig

inputDataConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder inputDataConfig(CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig - Specifies the format and location of the input data for the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig

languageCode

@Stability(Stable)
public CfnDocumentClassifier.Builder languageCode(String languageCode)

The language of the input documents.

You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-languagecode

mode

@Stability(Stable)
public CfnDocumentClassifier.Builder mode(String mode)

Indicates the mode in which the classifier will be trained.

The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Parameters:

mode - Indicates the mode in which the classifier will be trained. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-mode

modelKmsKeyId

@Stability(Stable)
public CfnDocumentClassifier.Builder modelKmsKeyId(String modelKmsKeyId)

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

The ModelKmsKeyId can be either 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"

Parameters:

modelKmsKeyId - ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelkmskeyid

modelPolicy

@Stability(Stable)
public CfnDocumentClassifier.Builder modelPolicy(String modelPolicy)

The resource-based policy to attach to your custom document classifier model.

You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Parameters:

modelPolicy - The resource-based policy to attach to your custom document classifier model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelpolicy

outputDataConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder outputDataConfig(IResolvable outputDataConfig)

Provides output results configuration parameters for custom classifier jobs.

Parameters:

outputDataConfig - Provides output results configuration parameters for custom classifier jobs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig

outputDataConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder outputDataConfig(CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty outputDataConfig)

Provides output results configuration parameters for custom classifier jobs.

Parameters:

outputDataConfig - Provides output results configuration parameters for custom classifier jobs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig

tags

@Stability(Stable)
public CfnDocumentClassifier.Builder tags(List<? extends CfnTag> tags)

Tags to associate with the document classifier.

A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the document classifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-tags

versionName

@Stability(Stable)
public CfnDocumentClassifier.Builder versionName(String versionName)

The version name given to the newly created classifier.

Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .

Parameters:

versionName - The version name given to the newly created classifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-versionname

volumeKmsKeyId

@Stability(Stable)
public CfnDocumentClassifier.Builder volumeKmsKeyId(String volumeKmsKeyId)

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.

The VolumeKmsKeyId can be either 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"

Parameters:

volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-volumekmskeyid

vpcConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder vpcConfig(IResolvable vpcConfig)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

For more information, see Amazon VPC .

Parameters:

vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig

vpcConfig

@Stability(Stable)
public CfnDocumentClassifier.Builder vpcConfig(CfnDocumentClassifier.VpcConfigProperty vpcConfig)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

For more information, see Amazon VPC .

Parameters:

vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig

build

@Stability(Stable)
public CfnDocumentClassifier build()

Specified by:

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

Returns:

a newly built instance of CfnDocumentClassifier.