Package software.amazon.awscdk.services.comprehend

Interface CfnEntityRecognizerEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntityRecognizerEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:51.146Z")
@Stability(Stable)
public interface CfnEntityRecognizerEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEntityRecognizerEndpoint.

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.*;
 CfnEntityRecognizerEndpointProps cfnEntityRecognizerEndpointProps = CfnEntityRecognizerEndpointProps.builder()
         .desiredInferenceUnits(123)
         .endpointName("endpointName")
         // the properties below are optional
         .dataAccessRoleArn("dataAccessRoleArn")
         .flywheelArn("flywheelArn")
         .modelArn("modelArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEntityRecognizerEndpointProps.Builder	A builder for CfnEntityRecognizerEndpointProps
static final class	CfnEntityRecognizerEndpointProps.Jsii$Proxy	An implementation for CfnEntityRecognizerEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnEntityRecognizerEndpointProps.Builder	builder()
default String	getDataAccessRoleArn()	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).
Number	getDesiredInferenceUnits()	The desired number of inference units to be used by the model.
String	getEndpointName()	The name of the endpoint.
default String	getFlywheelArn()	The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
default String	getModelArn()	The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
default List<CfnTag>	getTags()	Tags associated with the endpoint being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDesiredInferenceUnits

@Stability(Stable)
@NotNull
Number getDesiredInferenceUnits()

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

getEndpointName

@Stability(Stable)
@NotNull
String getEndpointName()

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

getDataAccessRoleArn

@Stability(Stable)
@Nullable
default String getDataAccessRoleArn()

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

getFlywheelArn

@Stability(Stable)
@Nullable
default String getFlywheelArn()

The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-flywheelarn

getModelArn

@Stability(Stable)
@Nullable
default String getModelArn()

The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-modelarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags associated with the endpoint being created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizerendpoint.html#cfn-comprehend-entityrecognizerendpoint-tags

builder

@Stability(Stable)
static CfnEntityRecognizerEndpointProps.Builder builder()

Returns:

a CfnEntityRecognizerEndpointProps.Builder of CfnEntityRecognizerEndpointProps