Interface CfnEntityRecognizerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEntityRecognizerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
date="2026-09-30T11:04:48.437Z")
@Stability(Stable)
public interface CfnEntityRecognizerProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnEntityRecognizer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.comprehend.*;
CfnEntityRecognizerProps cfnEntityRecognizerProps = CfnEntityRecognizerProps.builder()
.dataAccessRoleArn("dataAccessRoleArn")
.inputDataConfig(EntityRecognizerInputDataConfigProperty.builder()
.entityTypes(List.of(EntityTypesListItemProperty.builder()
.type("type")
.build()))
// the properties below are optional
.annotations(EntityRecognizerAnnotationsProperty.builder()
.s3Uri("s3Uri")
// the properties below are optional
.testS3Uri("testS3Uri")
.build())
.augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
.attributeNames(List.of("attributeNames"))
.s3Uri("s3Uri")
// the properties below are optional
.annotationDataS3Uri("annotationDataS3Uri")
.documentType("documentType")
.sourceDocumentsS3Uri("sourceDocumentsS3Uri")
.split("split")
.build()))
.dataFormat("dataFormat")
.documents(EntityRecognizerDocumentsProperty.builder()
.s3Uri("s3Uri")
// the properties below are optional
.inputFormat("inputFormat")
.testS3Uri("testS3Uri")
.build())
.entityList(EntityRecognizerEntityListProperty.builder()
.s3Uri("s3Uri")
.build())
.build())
.languageCode("languageCode")
.recognizerName("recognizerName")
// the properties below are optional
.modelKmsKeyId("modelKmsKeyId")
.modelPolicy("modelPolicy")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.versionName("versionName")
.volumeKmsKeyId("volumeKmsKeyId")
.vpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnets(List.of("subnets"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnEntityRecognizerPropsstatic final classAn implementation forCfnEntityRecognizerProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.Specifies the format and location of the input data for an entity recognizer.The language of the input documents.default StringID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.default StringThe JSON resource-based policy to attach to your custom entity recognizer model.The name given to the entity recognizer.getTags()Tags to associate with the entity recognizer.default StringThe version name given to the entity recognizer.default StringID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).default ObjectConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.- See Also:
-
getInputDataConfig
Specifies the format and location of the input data for an entity recognizer.Returns union: either
IResolvableorCfnEntityRecognizer.EntityRecognizerInputDataConfigProperty- See Also:
-
getLanguageCode
The language of the input documents.All documents must be in the same language.
- See Also:
-
getRecognizerName
The name given to the entity recognizer.- See Also:
-
getModelKmsKeyId
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.- See Also:
-
getModelPolicy
The JSON resource-based policy to attach to your custom entity recognizer model.- See Also:
-
getTags
Tags to associate with the entity recognizer.- See Also:
-
getVersionName
The version name given to the entity recognizer.- See Also:
-
getVolumeKmsKeyId
ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).- See Also:
-
getVpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.Returns union: either
IResolvableorCfnEntityRecognizer.VpcConfigProperty- See Also:
-
builder
- Returns:
- a
CfnEntityRecognizerProps.BuilderofCfnEntityRecognizerProps
-