Package software.amazon.awscdk.cfnpropertymixins.services.comprehend

Class CfnEntityRecognizerPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnEntityRecognizerPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:07.636Z")
@Stability(Stable)
public class CfnEntityRecognizerPropsMixin
extends Mixin
implements software.constructs.IMixin

An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.comprehend.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnEntityRecognizerPropsMixin cfnEntityRecognizerPropsMixin = CfnEntityRecognizerPropsMixin.Builder.create(CfnEntityRecognizerMixinProps.builder()
         .dataAccessRoleArn("dataAccessRoleArn")
         .inputDataConfig(EntityRecognizerInputDataConfigProperty.builder()
                 .annotations(EntityRecognizerAnnotationsProperty.builder()
                         .s3Uri("s3Uri")
                         .testS3Uri("testS3Uri")
                         .build())
                 .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                         .annotationDataS3Uri("annotationDataS3Uri")
                         .attributeNames(List.of("attributeNames"))
                         .documentType("documentType")
                         .s3Uri("s3Uri")
                         .sourceDocumentsS3Uri("sourceDocumentsS3Uri")
                         .split("split")
                         .build()))
                 .dataFormat("dataFormat")
                 .documents(EntityRecognizerDocumentsProperty.builder()
                         .inputFormat("inputFormat")
                         .s3Uri("s3Uri")
                         .testS3Uri("testS3Uri")
                         .build())
                 .entityList(EntityRecognizerEntityListProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .entityTypes(List.of(EntityTypesListItemProperty.builder()
                         .type("type")
                         .build()))
                 .build())
         .languageCode("languageCode")
         .modelKmsKeyId("modelKmsKeyId")
         .modelPolicy("modelPolicy")
         .recognizerName("recognizerName")
         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnEntityRecognizerPropsMixin.AugmentedManifestsListItemProperty	An augmented manifest file that provides training data for your custom model.
static final class	CfnEntityRecognizerPropsMixin.Builder	A fluent builder for CfnEntityRecognizerPropsMixin.
static interface	CfnEntityRecognizerPropsMixin.EntityRecognizerAnnotationsProperty	Describes the annotations associated with an entity recognizer.
static interface	CfnEntityRecognizerPropsMixin.EntityRecognizerDocumentsProperty	Describes the training documents submitted with an entity recognizer.
static interface	CfnEntityRecognizerPropsMixin.EntityRecognizerEntityListProperty	Describes the entity list submitted with an entity recognizer.
static interface	CfnEntityRecognizerPropsMixin.EntityRecognizerInputDataConfigProperty	Specifies the format and location of the input data for an entity recognizer.
static interface	CfnEntityRecognizerPropsMixin.EntityTypesListItemProperty	An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
static interface	CfnEntityRecognizerPropsMixin.VpcConfigProperty	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnEntityRecognizerPropsMixin(CfnEntityRecognizerMixinProps props)	Create a mixin to apply properties to AWS::Comprehend::EntityRecognizer.
	CfnEntityRecognizerPropsMixin(CfnEntityRecognizerMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Comprehend::EntityRecognizer.
protected	CfnEntityRecognizerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEntityRecognizerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnEntityRecognizerMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnEntityRecognizerPropsMixin

protected CfnEntityRecognizerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnEntityRecognizerPropsMixin

protected CfnEntityRecognizerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEntityRecognizerPropsMixin

@Stability(Stable)
public CfnEntityRecognizerPropsMixin(@NotNull
 CfnEntityRecognizerMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Comprehend::EntityRecognizer.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnEntityRecognizerPropsMixin

@Stability(Stable)
public CfnEntityRecognizerPropsMixin(@NotNull
 CfnEntityRecognizerMixinProps props)

Create a mixin to apply properties to AWS::Comprehend::EntityRecognizer.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnEntityRecognizerMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()