Class: AWSCDK::Comprehend::CfnDocumentClassifier::DocumentClassifierOutputDataConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
comprehend/cfn_document_classifier.rb

Overview

Provide the location for output data from a custom classifier job.

This field is mandatory if you are training a native document model.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(kms_key_id: nil, s3_uri: nil) ⇒ DocumentClassifierOutputDataConfigProperty

Returns a new instance of DocumentClassifierOutputDataConfigProperty.

Parameters:

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

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

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

    When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files.



910
911
912
913
914
915
 
# File 'comprehend/cfn_document_classifier.rb', line 910

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

Instance Attribute Details

#kms_key_id ⇒ String? (readonly)

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

The KmsKeyId can be one 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"
  • KMS Key Alias: "alias/ExampleAlias"
  • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

Returns:

  • (String, nil)

See Also:



928
929
930
 
# File 'comprehend/cfn_document_classifier.rb', line 928

def kms_key_id
  @kms_key_id
end

#s3_uri ⇒ String? (readonly)

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files.

The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz . It is a compressed archive that contains the confusion matrix.

Returns:

  • (String, nil)

See Also:



937
938
939
 
# File 'comprehend/cfn_document_classifier.rb', line 937

def s3_uri
  @s3_uri
end

Class Method Details

.jsii_properties ⇒ Object 



939
940
941
942
943
944
 
# File 'comprehend/cfn_document_classifier.rb', line 939

def self.jsii_properties
  {
    :kms_key_id => "kmsKeyId",
    :s3_uri => "s3Uri",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



946
947
948
949
950
951
952
953
 
# File 'comprehend/cfn_document_classifier.rb', line 946

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