Package software.amazon.awscdk.services.comprehend

Class CfnEntityRecognizer.Builder

java.lang.Object

software.amazon.awscdk.services.comprehend.CfnEntityRecognizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEntityRecognizer>

Enclosing class:

CfnEntityRecognizer

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

A fluent builder for CfnEntityRecognizer.

Method Summary

Modifier and Type	Method	Description
CfnEntityRecognizer	build()
static CfnEntityRecognizer.Builder	create(software.constructs.Construct scope, String id)
CfnEntityRecognizer.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
CfnEntityRecognizer.Builder	inputDataConfig(IResolvable inputDataConfig)	Specifies the format and location of the input data for an entity recognizer.
CfnEntityRecognizer.Builder	inputDataConfig(CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty inputDataConfig)	Specifies the format and location of the input data for an entity recognizer.
CfnEntityRecognizer.Builder	languageCode(String languageCode)	The language of the input documents.
CfnEntityRecognizer.Builder	modelKmsKeyId(String modelKmsKeyId)	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
CfnEntityRecognizer.Builder	modelPolicy(String modelPolicy)	The JSON resource-based policy to attach to your custom entity recognizer model.
CfnEntityRecognizer.Builder	recognizerName(String recognizerName)	The name given to the entity recognizer.
CfnEntityRecognizer.Builder	tags(List<? extends CfnTag> tags)	Tags to associate with the entity recognizer.
CfnEntityRecognizer.Builder	versionName(String versionName)	The version name given to the entity recognizer.
CfnEntityRecognizer.Builder	volumeKmsKeyId(String volumeKmsKeyId)	ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
CfnEntityRecognizer.Builder	vpcConfig(IResolvable vpcConfig)	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
CfnEntityRecognizer.Builder	vpcConfig(CfnEntityRecognizer.VpcConfigProperty vpcConfig)	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

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 CfnEntityRecognizer.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 CfnEntityRecognizer.Builder.

dataAccessRoleArn

@Stability(Stable)
public CfnEntityRecognizer.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-entityrecognizer.html#cfn-comprehend-entityrecognizer-dataaccessrolearn

inputDataConfig

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

Specifies the format and location of the input data for an entity recognizer.

Parameters:

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

Returns:

this

See Also:

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

inputDataConfig

@Stability(Stable)
public CfnEntityRecognizer.Builder inputDataConfig(CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty inputDataConfig)

Specifies the format and location of the input data for an entity recognizer.

Parameters:

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

Returns:

this

See Also:

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

languageCode

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

The language of the input documents.

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-entityrecognizer.html#cfn-comprehend-entityrecognizer-languagecode

recognizerName

@Stability(Stable)
public CfnEntityRecognizer.Builder recognizerName(String recognizerName)

The name given to the entity recognizer.

Parameters:

recognizerName - The name given to the entity recognizer. This parameter is required.

Returns:

this

See Also:

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

modelKmsKeyId

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

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

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-entityrecognizer.html#cfn-comprehend-entityrecognizer-modelkmskeyid

modelPolicy

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

The JSON resource-based policy to attach to your custom entity recognizer model.

Parameters:

modelPolicy - The JSON resource-based policy to attach to your custom entity recognizer model. This parameter is required.

Returns:

this

See Also:

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

tags

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

Tags to associate with the entity recognizer.

Parameters:

tags - Tags to associate with the entity recognizer. This parameter is required.

Returns:

this

See Also:

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

versionName

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

The version name given to the entity recognizer.

Parameters:

versionName - The version name given to the entity recognizer. This parameter is required.

Returns:

this

See Also:

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

volumeKmsKeyId

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

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

Parameters:

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

Returns:

this

See Also:

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

vpcConfig

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

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

Parameters:

vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. This parameter is required.

Returns:

this

See Also:

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

vpcConfig

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

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

Parameters:

vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEntityRecognizer build()

Specified by:

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

Returns:

a newly built instance of CfnEntityRecognizer.