Class: AWSCDK::Kendra::CfnDataSource::CustomDocumentEnrichmentConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(inline_configurations: nil, post_extraction_hook_configuration: nil, pre_extraction_hook_configuration: nil, role_arn: nil) ⇒ CustomDocumentEnrichmentConfigurationProperty

Returns a new instance of CustomDocumentEnrichmentConfigurationProperty.

Parameters:



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'kendra/cfn_data_source.rb', line 1458

def initialize(inline_configurations: nil, post_extraction_hook_configuration: nil, pre_extraction_hook_configuration: nil, role_arn: nil)
  @inline_configurations = inline_configurations
  Jsii::Type.check_type(@inline_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuSW5saW5lQ3VzdG9tRG9jdW1lbnRFbnJpY2htZW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "inlineConfigurations") unless @inline_configurations.nil?
  @post_extraction_hook_configuration = post_extraction_hook_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::HookConfigurationProperty.new(**post_extraction_hook_configuration.transform_keys(&:to_sym)) : post_extraction_hook_configuration
  Jsii::Type.check_type(@post_extraction_hook_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Ib29rQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "postExtractionHookConfiguration") unless @post_extraction_hook_configuration.nil?
  @pre_extraction_hook_configuration = pre_extraction_hook_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::HookConfigurationProperty.new(**pre_extraction_hook_configuration.transform_keys(&:to_sym)) : pre_extraction_hook_configuration
  Jsii::Type.check_type(@pre_extraction_hook_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Ib29rQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "preExtractionHookConfiguration") unless @pre_extraction_hook_configuration.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#inline_configurations ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

Returns:

See Also:



1473
1474
1475
 
# File 'kendra/cfn_data_source.rb', line 1473

def inline_configurations
  @inline_configurations
end

#post_extraction_hook_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .

Returns:

See Also:



1480
1481
1482
 
# File 'kendra/cfn_data_source.rb', line 1480

def post_extraction_hook_configuration
  @post_extraction_hook_configuration
end

#pre_extraction_hook_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .

Returns:

See Also:



1487
1488
1489
 
# File 'kendra/cfn_data_source.rb', line 1487

def pre_extraction_hook_configuration
  @pre_extraction_hook_configuration
end

#role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

For more information, see an IAM roles for Amazon Kendra .

Returns:

  • (String, nil)

See Also:



1494
1495
1496
 
# File 'kendra/cfn_data_source.rb', line 1494

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1496
1497
1498
1499
1500
1501
1502
1503
 
# File 'kendra/cfn_data_source.rb', line 1496

def self.jsii_properties
  {
    :inline_configurations => "inlineConfigurations",
    :post_extraction_hook_configuration => "postExtractionHookConfiguration",
    :pre_extraction_hook_configuration => "preExtractionHookConfiguration",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'kendra/cfn_data_source.rb', line 1505

def to_jsii
  result = {}
  result.merge!({
    "inlineConfigurations" => @inline_configurations,
    "postExtractionHookConfiguration" => @post_extraction_hook_configuration,
    "preExtractionHookConfiguration" => @pre_extraction_hook_configuration,
    "roleArn" => @role_arn,
  })
  result.compact
end