View a markdown version of this page

AWS::Comprehend::EntityRecognizer - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Comprehend::EntityRecognizer

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Comprehend::EntityRecognizer",
  "Properties" : {
      "DataAccessRoleArn" : String,
      "InputDataConfig" : EntityRecognizerInputDataConfig,
      "LanguageCode" : String,
      "ModelKmsKeyId" : String,
      "ModelPolicy" : String,
      "RecognizerName" : String,
      "Tags" : [ Tag, ... ],
      "VersionName" : String,
      "VolumeKmsKeyId" : String,
      "VpcConfig" : VpcConfig
    }
}

YAML

Type: AWS::Comprehend::EntityRecognizer
Properties:
  DataAccessRoleArn: String
  InputDataConfig: 
    EntityRecognizerInputDataConfig
  LanguageCode: String
  ModelKmsKeyId: String
  ModelPolicy: String
  RecognizerName: String
  Tags: 
    - Tag
  VersionName: String
  VolumeKmsKeyId: String
  VpcConfig: 
    VpcConfig

Properties

DataAccessRoleArn

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

InputDataConfig

The input data properties of an entity recognizer.

Required: Yes

Type: EntityRecognizerInputDataConfig

Update requires: Replacement

LanguageCode

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Required: Yes

Type: String

Allowed values: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

Update requires: Replacement

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"

Required: No

Type: String

Pattern: ^\p{ASCII}+$

Maximum: 2048

Update requires: Replacement

ModelPolicy

Property description not available.

Required: No

Type: String

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]+$

Minimum: 1

Maximum: 20000

Update requires: Replacement

RecognizerName

The name that you assigned the entity recognizer.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Maximum: 63

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

VersionName

The version name you assigned to the entity recognizer.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Maximum: 63

Update requires: Replacement

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"

Required: No

Type: String

Pattern: ^\p{ASCII}+$

Maximum: 2048

Update requires: Replacement

VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Required: No

Type: VpcConfig

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.