# CfnEntityRecognizerProps

Properties for defining a `CfnEntityRecognizer`.

Used as props by: [CfnEntityRecognizer](/cdk/api/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.html)

- Source: Generated at build time
- Type last changed: v2.272.0 · 30 Sep 2026

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_comprehend as comprehend } from 'aws-cdk-lib';
const cfnEntityRecognizerProps: comprehend.CfnEntityRecognizerProps = {
  dataAccessRoleArn: 'dataAccessRoleArn',
  inputDataConfig: {
    entityTypes: [{
      type: 'type',
    }],

    // the properties below are optional
    annotations: {
      s3Uri: 's3Uri',

      // the properties below are optional
      testS3Uri: 'testS3Uri',
    },
    augmentedManifests: [{
      attributeNames: ['attributeNames'],
      s3Uri: 's3Uri',

      // the properties below are optional
      annotationDataS3Uri: 'annotationDataS3Uri',
      documentType: 'documentType',
      sourceDocumentsS3Uri: 'sourceDocumentsS3Uri',
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documents: {
      s3Uri: 's3Uri',

      // the properties below are optional
      inputFormat: 'inputFormat',
      testS3Uri: 'testS3Uri',
    },
    entityList: {
      s3Uri: 's3Uri',
    },
  },
  languageCode: 'languageCode',
  recognizerName: 'recognizerName',

  // the properties below are optional
  modelKmsKeyId: 'modelKmsKeyId',
  modelPolicy: 'modelPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionName: 'versionName',
  volumeKmsKeyId: 'volumeKmsKeyId',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
  },
};
```

Python:

```python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

cfn_entity_recognizer_props = comprehend.CfnEntityRecognizerProps(
    data_access_role_arn="dataAccessRoleArn",
    input_data_config=comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty(
        entity_types=[comprehend.CfnEntityRecognizer.EntityTypesListItemProperty(
            type="type"
        )],

        # the properties below are optional
        annotations=comprehend.CfnEntityRecognizer.EntityRecognizerAnnotationsProperty(
            s3_uri="s3Uri",

            # the properties below are optional
            test_s3_uri="testS3Uri"
        ),
        augmented_manifests=[comprehend.CfnEntityRecognizer.AugmentedManifestsListItemProperty(
            attribute_names=["attributeNames"],
            s3_uri="s3Uri",

            # the properties below are optional
            annotation_data_s3_uri="annotationDataS3Uri",
            document_type="documentType",
            source_documents_s3_uri="sourceDocumentsS3Uri",
            split="split"
        )],
        data_format="dataFormat",
        documents=comprehend.CfnEntityRecognizer.EntityRecognizerDocumentsProperty(
            s3_uri="s3Uri",

            # the properties below are optional
            input_format="inputFormat",
            test_s3_uri="testS3Uri"
        ),
        entity_list=comprehend.CfnEntityRecognizer.EntityRecognizerEntityListProperty(
            s3_uri="s3Uri"
        )
    ),
    language_code="languageCode",
    recognizer_name="recognizerName",

    # the properties below are optional
    model_kms_key_id="modelKmsKeyId",
    model_policy="modelPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_name="versionName",
    volume_kms_key_id="volumeKmsKeyId",
    vpc_config=comprehend.CfnEntityRecognizer.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"]
    )
)
```

Java:

```java
// 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Comprehend;

var cfnEntityRecognizerProps = new CfnEntityRecognizerProps {
    DataAccessRoleArn = "dataAccessRoleArn",
    InputDataConfig = new EntityRecognizerInputDataConfigProperty {
        EntityTypes = new [] { new EntityTypesListItemProperty {
            Type = "type"
        } },

        // the properties below are optional
        Annotations = new EntityRecognizerAnnotationsProperty {
            S3Uri = "s3Uri",

            // the properties below are optional
            TestS3Uri = "testS3Uri"
        },
        AugmentedManifests = new [] { new AugmentedManifestsListItemProperty {
            AttributeNames = new [] { "attributeNames" },
            S3Uri = "s3Uri",

            // the properties below are optional
            AnnotationDataS3Uri = "annotationDataS3Uri",
            DocumentType = "documentType",
            SourceDocumentsS3Uri = "sourceDocumentsS3Uri",
            Split = "split"
        } },
        DataFormat = "dataFormat",
        Documents = new EntityRecognizerDocumentsProperty {
            S3Uri = "s3Uri",

            // the properties below are optional
            InputFormat = "inputFormat",
            TestS3Uri = "testS3Uri"
        },
        EntityList = new EntityRecognizerEntityListProperty {
            S3Uri = "s3Uri"
        }
    },
    LanguageCode = "languageCode",
    RecognizerName = "recognizerName",

    // the properties below are optional
    ModelKmsKeyId = "modelKmsKeyId",
    ModelPolicy = "modelPolicy",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VersionName = "versionName",
    VolumeKmsKeyId = "volumeKmsKeyId",
    VpcConfig = new VpcConfigProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        Subnets = new [] { "subnets" }
    }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEntityRecognizerProps := &CfnEntityRecognizerProps{
	DataAccessRoleArn: jsii.String("dataAccessRoleArn"),
	InputDataConfig: &EntityRecognizerInputDataConfigProperty{
		EntityTypes: []interface{}{
			&EntityTypesListItemProperty{
				Type: jsii.String("type"),
			},
		},

		// the properties below are optional
		Annotations: &EntityRecognizerAnnotationsProperty{
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			TestS3Uri: jsii.String("testS3Uri"),
		},
		AugmentedManifests: []interface{}{
			&AugmentedManifestsListItemProperty{
				AttributeNames: []*string{
					jsii.String("attributeNames"),
				},
				S3Uri: jsii.String("s3Uri"),

				// the properties below are optional
				AnnotationDataS3Uri: jsii.String("annotationDataS3Uri"),
				DocumentType: jsii.String("documentType"),
				SourceDocumentsS3Uri: jsii.String("sourceDocumentsS3Uri"),
				Split: jsii.String("split"),
			},
		},
		DataFormat: jsii.String("dataFormat"),
		Documents: &EntityRecognizerDocumentsProperty{
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			InputFormat: jsii.String("inputFormat"),
			TestS3Uri: jsii.String("testS3Uri"),
		},
		EntityList: &EntityRecognizerEntityListProperty{
			S3Uri: jsii.String("s3Uri"),
		},
	},
	LanguageCode: jsii.String("languageCode"),
	RecognizerName: jsii.String("recognizerName"),

	// the properties below are optional
	ModelKmsKeyId: jsii.String("modelKmsKeyId"),
	ModelPolicy: jsii.String("modelPolicy"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VersionName: jsii.String("versionName"),
	VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
	VpcConfig: &VpcConfigProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		Subnets: []*string{
			jsii.String("subnets"),
		},
	},
}
```

## Properties

- `dataAccessRoleArn`: string (required) — The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

- `inputDataConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty.html) (required) — Specifies the format and location of the input data for an entity recognizer.

- `languageCode`: string (required) — The language of the input documents.

  All documents must be in the same language.

- `modelKmsKeyId`: string — ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

- `modelPolicy`: string — The JSON resource-based policy to attach to your custom entity recognizer model.

- `recognizerName`: string (required) — The name given to the entity recognizer.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags to associate with the entity recognizer.

- `versionName`: string — The version name given to the entity recognizer.

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

- `vpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEntityRecognizer.VpcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_comprehend.CfnEntityRecognizer.VpcConfigProperty.html) — Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
