Package software.amazon.awscdk.services.comprehend

Class CfnDocumentClassifierProps.Builder

java.lang.Object

software.amazon.awscdk.services.comprehend.CfnDocumentClassifierProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentClassifierProps>

Enclosing interface:

CfnDocumentClassifierProps

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

A builder for CfnDocumentClassifierProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDocumentClassifierProps	build()	Builds the configured instance.
CfnDocumentClassifierProps.Builder	dataAccessRoleArn(String dataAccessRoleArn)	Sets the value of CfnDocumentClassifierProps.getDataAccessRoleArn()
CfnDocumentClassifierProps.Builder	documentClassifierName(String documentClassifierName)	Sets the value of CfnDocumentClassifierProps.getDocumentClassifierName()
CfnDocumentClassifierProps.Builder	inputDataConfig(IResolvable inputDataConfig)	Sets the value of CfnDocumentClassifierProps.getInputDataConfig()
CfnDocumentClassifierProps.Builder	inputDataConfig(CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty inputDataConfig)	Sets the value of CfnDocumentClassifierProps.getInputDataConfig()
CfnDocumentClassifierProps.Builder	languageCode(String languageCode)	Sets the value of CfnDocumentClassifierProps.getLanguageCode()
CfnDocumentClassifierProps.Builder	mode(String mode)	Sets the value of CfnDocumentClassifierProps.getMode()
CfnDocumentClassifierProps.Builder	modelKmsKeyId(String modelKmsKeyId)	Sets the value of CfnDocumentClassifierProps.getModelKmsKeyId()
CfnDocumentClassifierProps.Builder	modelPolicy(String modelPolicy)	Sets the value of CfnDocumentClassifierProps.getModelPolicy()
CfnDocumentClassifierProps.Builder	outputDataConfig(IResolvable outputDataConfig)	Sets the value of CfnDocumentClassifierProps.getOutputDataConfig()
CfnDocumentClassifierProps.Builder	outputDataConfig(CfnDocumentClassifier.DocumentClassifierOutputDataConfigProperty outputDataConfig)	Sets the value of CfnDocumentClassifierProps.getOutputDataConfig()
CfnDocumentClassifierProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDocumentClassifierProps.getTags()
CfnDocumentClassifierProps.Builder	versionName(String versionName)	Sets the value of CfnDocumentClassifierProps.getVersionName()
CfnDocumentClassifierProps.Builder	volumeKmsKeyId(String volumeKmsKeyId)	Sets the value of CfnDocumentClassifierProps.getVolumeKmsKeyId()
CfnDocumentClassifierProps.Builder	vpcConfig(IResolvable vpcConfig)	Sets the value of CfnDocumentClassifierProps.getVpcConfig()
CfnDocumentClassifierProps.Builder	vpcConfig(CfnDocumentClassifier.VpcConfigProperty vpcConfig)	Sets the value of CfnDocumentClassifierProps.getVpcConfig()

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

dataAccessRoleArn

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

Sets the value of CfnDocumentClassifierProps.getDataAccessRoleArn()

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

documentClassifierName

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

Sets the value of CfnDocumentClassifierProps.getDocumentClassifierName()

Parameters:

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

Returns:

this

inputDataConfig

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

Sets the value of CfnDocumentClassifierProps.getInputDataConfig()

Parameters:

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

Returns:

this

inputDataConfig

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

Sets the value of CfnDocumentClassifierProps.getInputDataConfig()

Parameters:

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

Returns:

this

languageCode

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

Sets the value of CfnDocumentClassifierProps.getLanguageCode()

Parameters:

languageCode - The language of the input documents. This parameter is required. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

this

mode

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

Sets the value of CfnDocumentClassifierProps.getMode()

Parameters:

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 (|).

Returns:

this

modelKmsKeyId

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

Sets the value of CfnDocumentClassifierProps.getModelKmsKeyId()

Parameters:

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"

Returns:

this

modelPolicy

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

Sets the value of CfnDocumentClassifierProps.getModelPolicy()

Parameters:

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"]}'

Returns:

this

outputDataConfig

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

Sets the value of CfnDocumentClassifierProps.getOutputDataConfig()

Parameters:

outputDataConfig - Provides output results configuration parameters for custom classifier jobs.

Returns:

this

outputDataConfig

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

Sets the value of CfnDocumentClassifierProps.getOutputDataConfig()

Parameters:

outputDataConfig - Provides output results configuration parameters for custom classifier jobs.

Returns:

this

tags

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

Sets the value of CfnDocumentClassifierProps.getTags()

Parameters:

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.

Returns:

this

versionName

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

Sets the value of CfnDocumentClassifierProps.getVersionName()

Parameters:

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 .

Returns:

this

volumeKmsKeyId

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

Sets the value of CfnDocumentClassifierProps.getVolumeKmsKeyId()

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. 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"

Returns:

this

vpcConfig

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

Sets the value of CfnDocumentClassifierProps.getVpcConfig()

Parameters:

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 .

Returns:

this

vpcConfig

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

Sets the value of CfnDocumentClassifierProps.getVpcConfig()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnDocumentClassifierProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDocumentClassifierProps

Throws:

NullPointerException - if any required attribute was not provided