Package software.amazon.awscdk.cfnpropertymixins.services.comprehend

Class CfnDocumentClassifierMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnDocumentClassifierMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDocumentClassifierMixinProps

@Stability(Stable)
@Internal
public static final class CfnDocumentClassifierMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDocumentClassifierMixinProps

An implementation for CfnDocumentClassifierMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierMixinProps

CfnDocumentClassifierMixinProps.Builder, CfnDocumentClassifierMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDocumentClassifierMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDocumentClassifierMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
final String	getDocumentClassifierName()	The name of the document classifier.
final Object	getInputDataConfig()	Specifies the format and location of the input data for the job.
final String	getLanguageCode()	The language of the input documents.
final String	getMode()	Indicates the mode in which the classifier will be trained.
final String	getModelKmsKeyId()	ID for the AWS key that Amazon Comprehend uses to encrypt trained custom models.
final String	getModelPolicy()	The resource-based policy to attach to your custom document classifier model.
final Object	getOutputDataConfig()	Provides output results configuration parameters for custom classifier jobs.
final List<CfnTag>	getTags()	Tags to associate with the document classifier.
final String	getVersionName()	The version name given to the newly created classifier.
final String	getVolumeKmsKeyId()	ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
final Object	getVpcConfig()	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDocumentClassifierMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDocumentClassifierMixinProps.Builder.

Method Details

getDataAccessRoleArn

public final String getDataAccessRoleArn()

Description copied from interface: CfnDocumentClassifierMixinProps

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Specified by:

getDataAccessRoleArn in interface CfnDocumentClassifierMixinProps

See Also:

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

getDocumentClassifierName

public final String getDocumentClassifierName()

Description copied from interface: CfnDocumentClassifierMixinProps

The name of the document classifier.

Specified by:

getDocumentClassifierName in interface CfnDocumentClassifierMixinProps

See Also:

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

getInputDataConfig

public final Object getInputDataConfig()

Description copied from interface: CfnDocumentClassifierMixinProps

Specifies the format and location of the input data for the job.

Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

Specified by:

getInputDataConfig in interface CfnDocumentClassifierMixinProps

See Also:

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

getLanguageCode

public final String getLanguageCode()

Description copied from interface: CfnDocumentClassifierMixinProps

The language of the input documents.

You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Specified by:

getLanguageCode in interface CfnDocumentClassifierMixinProps

See Also:

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

getMode

public final String getMode()

Description copied from interface: CfnDocumentClassifierMixinProps

Indicates the mode in which the classifier will be trained.

The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Specified by:

getMode in interface CfnDocumentClassifierMixinProps

See Also:

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

getModelKmsKeyId

public final String getModelKmsKeyId()

Description copied from interface: CfnDocumentClassifierMixinProps

ID for the AWS key that Amazon Comprehend uses to encrypt trained custom models.

The ModelKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Specified by:

getModelKmsKeyId in interface CfnDocumentClassifierMixinProps

See Also:

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

getModelPolicy

public final String getModelPolicy()

Description copied from interface: CfnDocumentClassifierMixinProps

The resource-based policy to attach to your custom document classifier model.

You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Specified by:

getModelPolicy in interface CfnDocumentClassifierMixinProps

See Also:

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

getOutputDataConfig

public final Object getOutputDataConfig()

Description copied from interface: CfnDocumentClassifierMixinProps

Provides output results configuration parameters for custom classifier jobs.

Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.DocumentClassifierOutputDataConfigProperty

Specified by:

getOutputDataConfig in interface CfnDocumentClassifierMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDocumentClassifierMixinProps

Tags to associate with the document classifier.

A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Specified by:

getTags in interface CfnDocumentClassifierMixinProps

See Also:

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

getVersionName

public final String getVersionName()

Description copied from interface: CfnDocumentClassifierMixinProps

The version name given to the newly created classifier.

Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .

Specified by:

getVersionName in interface CfnDocumentClassifierMixinProps

See Also:

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

getVolumeKmsKeyId

public final String getVolumeKmsKeyId()

Description copied from interface: CfnDocumentClassifierMixinProps

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.

The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Specified by:

getVolumeKmsKeyId in interface CfnDocumentClassifierMixinProps

See Also:

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

getVpcConfig

public final Object getVpcConfig()

Description copied from interface: CfnDocumentClassifierMixinProps

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

For more information, see Amazon VPC .

Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.VpcConfigProperty

Specified by:

getVpcConfig in interface CfnDocumentClassifierMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object