Package software.amazon.awscdk.services.comprehend

Interface CfnDocumentClassifierEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentClassifierEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:48.431Z")
@Stability(Stable)
public interface CfnDocumentClassifierEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDocumentClassifierEndpoint.

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDocumentClassifierEndpointProps.Builder	builder()
Number	getDesiredInferenceUnits()	The desired number of inference units to be used by the model.
String	getEndpointName()	The name of the endpoint.
String	getModelArn()	The Amazon Resource Name (ARN) of the document classifier 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-documentclassifierendpoint.html#cfn-comprehend-documentclassifierendpoint-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-documentclassifierendpoint.html#cfn-comprehend-documentclassifierendpoint-endpointname

getModelArn

@Stability(Stable)
@NotNull
String getModelArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifierendpoint.html#cfn-comprehend-documentclassifierendpoint-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-documentclassifierendpoint.html#cfn-comprehend-documentclassifierendpoint-tags

builder

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

Returns:

a CfnDocumentClassifierEndpointProps.Builder of CfnDocumentClassifierEndpointProps