CfnEntityRecognizerEndpointProps

class aws_cdk.aws_comprehend.CfnEntityRecognizerEndpointProps(*, desired_inference_units, endpoint_name, data_access_role_arn=None, flywheel_arn=None, model_arn=None, tags=None)

Bases: object

Properties for defining a CfnEntityRecognizerEndpoint.

Parameters:
  • desired_inference_units (Union[int, float]) – The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.

  • endpoint_name (str) – The name of the endpoint. The name must be unique within the AWS Region and account.

  • data_access_role_arn (Optional[str]) – 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).

  • flywheel_arn (Optional[str]) – The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.

  • model_arn (Optional[str]) – The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags associated with the endpoint being created.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

cfn_entity_recognizer_endpoint_props = comprehend.CfnEntityRecognizerEndpointProps(
    desired_inference_units=123,
    endpoint_name="endpointName",

    # the properties below are optional
    data_access_role_arn="dataAccessRoleArn",
    flywheel_arn="flywheelArn",
    model_arn="modelArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_access_role_arn

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:

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

desired_inference_units

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

Each inference unit represents throughput of 100 characters per second.

See:

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

endpoint_name

The name of the endpoint.

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

See:

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

flywheel_arn

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

See:

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

model_arn

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

See:

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

tags

Tags associated with the endpoint being created.

See:

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