Class: AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierDocumentsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierDocumentsProperty

Defined in:

comprehend/cfn_document_classifier.rb

Overview

The location of the training documents.

This parameter is required in a request to create a semi-structured document classification model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html

Instance Attribute Summary

• #s3_uri ⇒ String readonly

  The S3 URI location of the training documents specified in the S3Uri CSV file.

• #test_s3_uri ⇒ String^? readonly

  The S3 URI location of the test documents included in the TestS3Uri CSV file.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(s3_uri:, test_s3_uri: nil) ⇒ DocumentClassifierDocumentsProperty constructor

  A new instance of DocumentClassifierDocumentsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(s3_uri:, test_s3_uri: nil) ⇒ DocumentClassifierDocumentsProperty

Returns a new instance of DocumentClassifierDocumentsProperty.

Parameters:

• s3_uri (String) —

  The S3 URI location of the training documents specified in the S3Uri CSV file.

• test_s3_uri (String, nil) (defaults to: nil) —

  The S3 URI location of the test documents included in the TestS3Uri CSV file.

# File 'comprehend/cfn_document_classifier.rb', line 735

def initialize(s3_uri:, test_s3_uri: nil)
  @s3_uri = s3_uri
  Jsii::Type.check_type(@s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Uri")
  @test_s3_uri = test_s3_uri
  Jsii::Type.check_type(@test_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "testS3Uri") unless @test_s3_uri.nil?
end

Instance Attribute Details

#s3_uri ⇒ String (readonly)

The S3 URI location of the training documents specified in the S3Uri CSV file.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-s3uri

# File 'comprehend/cfn_document_classifier.rb', line 746

def s3_uri
  @s3_uri
end

#test_s3_uri ⇒ String^? (readonly)

The S3 URI location of the test documents included in the TestS3Uri CSV file.

This field is not required if you do not specify a test CSV file.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-tests3uri

# File 'comprehend/cfn_document_classifier.rb', line 753

def test_s3_uri
  @test_s3_uri
end

Class Method Details

.jsii_properties ⇒ Object

# File 'comprehend/cfn_document_classifier.rb', line 755

def self.jsii_properties
  {
    :s3_uri => "s3Uri",
    :test_s3_uri => "testS3Uri",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'comprehend/cfn_document_classifier.rb', line 762

def to_jsii
  result = {}
  result.merge!({
    "s3Uri" => @s3_uri,
    "testS3Uri" => @test_s3_uri,
  })
  result.compact
end