interface CfnEntityRecognizerEndpointProps

Language	Type name
.NET	`Amazon.CDK.AWS.Comprehend.CfnEntityRecognizerEndpointProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscomprehend#CfnEntityRecognizerEndpointProps`
Java	`software.amazon.awscdk.services.comprehend.CfnEntityRecognizerEndpointProps`
Python	`aws_cdk.aws_comprehend.CfnEntityRecognizerEndpointProps`
TypeScript	`aws-cdk-lib` » `aws_comprehend` » `CfnEntityRecognizerEndpointProps`

Properties for defining a CfnEntityRecognizerEndpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html

Example

// 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 cfnEntityRecognizerEndpointProps: comprehend.CfnEntityRecognizerEndpointProps = {
  desiredInferenceUnits: 123,
  endpointName: 'endpointName',

  // the properties below are optional
  dataAccessRoleArn: 'dataAccessRoleArn',
  flywheelArn: 'flywheelArn',
  modelArn: 'modelArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
desiredInferenceUnits	`number`	The desired number of inference units to be used by the model.
endpointName	`string`	The name of the endpoint.
dataAccessRoleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
flywheelArn?	`string`	The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
modelArn?	`string`	The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
tags?	`CfnTag[]`	Tags associated with the endpoint being created.

desiredInferenceUnits

Type: number

The desired number of inference units to be used by the model.

Each inference unit represents throughput of 100 characters per second.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-desiredinferenceunits

endpointName

Type: string

The name of the endpoint.

The name must be unique within the AWS Region and account.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-endpointname

dataAccessRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-dataaccessrolearn