Class CfnEntityRecognizerEndpointProps

Properties for defining a CfnEntityRecognizerEndpoint.

Inheritance

object

CfnEntityRecognizerEndpointProps

Implements

ICfnEntityRecognizerEndpointProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Comprehend

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEntityRecognizerEndpointProps : ICfnEntityRecognizerEndpointProps

Syntax (vb)

Public Class CfnEntityRecognizerEndpointProps Implements ICfnEntityRecognizerEndpointProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Comprehend;

             var cfnEntityRecognizerEndpointProps = new CfnEntityRecognizerEndpointProps {
                 DesiredInferenceUnits = 123,
                 EndpointName = "endpointName",

                 // the properties below are optional
                 DataAccessRoleArn = "dataAccessRoleArn",
                 FlywheelArn = "flywheelArn",
                 ModelArn = "modelArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnEntityRecognizerEndpointProps()

Properties for defining a CfnEntityRecognizerEndpoint.

Properties

DataAccessRoleArn	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).
DesiredInferenceUnits	The desired number of inference units to be used by the model.
EndpointName	The name of the endpoint.
FlywheelArn	The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
ModelArn	The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
Tags	Tags associated with the endpoint being created.

Constructors

CfnEntityRecognizerEndpointProps()

Properties for defining a CfnEntityRecognizerEndpoint.

public CfnEntityRecognizerEndpointProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Comprehend;

             var cfnEntityRecognizerEndpointProps = new CfnEntityRecognizerEndpointProps {
                 DesiredInferenceUnits = 123,
                 EndpointName = "endpointName",

                 // the properties below are optional
                 DataAccessRoleArn = "dataAccessRoleArn",
                 FlywheelArn = "flywheelArn",
                 ModelArn = "modelArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DataAccessRoleArn

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).

public string? DataAccessRoleArn { get; set; }

Property Value

string

Remarks

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

DesiredInferenceUnits

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

public double DesiredInferenceUnits { get; set; }

Property Value

double

Remarks

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

EndpointName

The name of the endpoint.

public string EndpointName { get; set; }

Property Value

string

Remarks

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

FlywheelArn

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

public string? FlywheelArn { get; set; }

Property Value

string

Remarks

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

ModelArn

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

public string? ModelArn { get; set; }