Package software.amazon.awscdk.services.comprehend

Class CfnEntityRecognizerEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.comprehend.CfnEntityRecognizerEndpoint
All Implemented Interfaces:
IInspectable, IEntityRecognizerEndpointRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-10-08T16:59:51.145Z") @Stability(Stable) public class CfnEntityRecognizerEndpoint extends CfnResource implements IInspectable, IEntityRecognizerEndpointRef, ITaggableV2
An Amazon Comprehend endpoint that hosts a custom entity recognizer model for real-time inference.

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.*;
 CfnEntityRecognizerEndpoint cfnEntityRecognizerEndpoint = CfnEntityRecognizerEndpoint.Builder.create(this, "MyCfnEntityRecognizerEndpoint")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEntityRecognizerEndpoint

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

    • CfnEntityRecognizerEndpoint

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

    • CfnEntityRecognizerEndpoint

      @Stability(Stable) public CfnEntityRecognizerEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEntityRecognizerEndpointProps props)
      Create a new AWS::Comprehend::EntityRecognizerEndpoint.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForEntityRecognizerEndpoint

      @Stability(Stable) @NotNull public static String arnForEntityRecognizerEndpoint(@NotNull IEntityRecognizerEndpointRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnEntityRecognizerEndpoint

      @Stability(Stable) @NotNull public static Boolean isCfnEntityRecognizerEndpoint(@NotNull Object x)
      Checks whether the given object is a CfnEntityRecognizerEndpoint.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the entity recognizer endpoint.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The creation date and time of the endpoint.

    • getAttrCurrentInferenceUnits

      @Stability(Stable) @NotNull public Number getAttrCurrentInferenceUnits()
      The number of inference units currently used by the model using this endpoint.

    • getAttrEndpointStatus

      @Stability(Stable) @NotNull public String getAttrEndpointStatus()
      The current status of the endpoint.

      Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The date and time that the endpoint was last modified.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getEntityRecognizerEndpointRef

      @Stability(Stable) @NotNull public EntityRecognizerEndpointReference getEntityRecognizerEndpointRef()
      A reference to a EntityRecognizerEndpoint resource.
      Specified by:
      getEntityRecognizerEndpointRef in interface IEntityRecognizerEndpointRef

    • getDesiredInferenceUnits

      @Stability(Stable) @NotNull public Number getDesiredInferenceUnits()
      The desired number of inference units to be used by the model.

    • setDesiredInferenceUnits

      @Stability(Stable) public void setDesiredInferenceUnits(@NotNull Number value)
      The desired number of inference units to be used by the model.

    • getEndpointName

      @Stability(Stable) @NotNull public String getEndpointName()
      The name of the endpoint.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@NotNull String value)
      The name of the endpoint.

    • getDataAccessRoleArn

      @Stability(Stable) @Nullable public 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).

    • setDataAccessRoleArn

      @Stability(Stable) public void setDataAccessRoleArn(@Nullable String value)
      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).

    • getFlywheelArn

      @Stability(Stable) @Nullable public String getFlywheelArn()
      The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.

    • setFlywheelArn

      @Stability(Stable) public void setFlywheelArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.

    • getModelArn

      @Stability(Stable) @Nullable public String getModelArn()
      The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.

    • setModelArn

      @Stability(Stable) public void setModelArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags associated with the endpoint being created.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags associated with the endpoint being created.