Class: AWSCDK::Kendra::CfnDataSource::DocumentsMetadataConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnDataSource::DocumentsMetadataConfigurationProperty

Defined in:

kendra/cfn_data_source.rb

Overview

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.

Each metadata file contains metadata about a single document.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentsmetadataconfiguration.html

Instance Attribute Summary

• #s3_prefix ⇒ String^? readonly

  A prefix used to filter metadata configuration files in the AWS S3 bucket.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(s3_prefix: nil) ⇒ DocumentsMetadataConfigurationProperty constructor

  A new instance of DocumentsMetadataConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(s3_prefix: nil) ⇒ DocumentsMetadataConfigurationProperty

Returns a new instance of DocumentsMetadataConfigurationProperty.

Parameters:

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

  A prefix used to filter metadata configuration files in the AWS S3 bucket.

# File 'kendra/cfn_data_source.rb', line 2059

def initialize(s3_prefix: nil)
  @s3_prefix = s3_prefix
  Jsii::Type.check_type(@s3_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Prefix") unless @s3_prefix.nil?
end

Instance Attribute Details

#s3_prefix ⇒ String^? (readonly)

A prefix used to filter metadata configuration files in the AWS S3 bucket.

The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentsmetadataconfiguration.html#cfn-kendra-datasource-documentsmetadataconfiguration-s3prefix

# File 'kendra/cfn_data_source.rb', line 2070

def s3_prefix
  @s3_prefix
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_data_source.rb', line 2072

def self.jsii_properties
  {
    :s3_prefix => "s3Prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_data_source.rb', line 2078

def to_jsii
  result = {}
  result.merge!({
    "s3Prefix" => @s3_prefix,
  })
  result.compact
end