Class: AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessConfigurationProperty

Defined in:

bedrock/cfn_knowledge_base.rb

Overview

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service.

For more information, see Create a vector index in Amazon OpenSearch Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html

Instance Attribute Summary

• #collection_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

• #field_mapping ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty readonly

  Contains the names of the fields to which to map information about the vector store.

• #vector_index_name ⇒ String readonly

  The name of the vector store.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(collection_arn:, field_mapping:, vector_index_name:) ⇒ OpenSearchServerlessConfigurationProperty constructor

  A new instance of OpenSearchServerlessConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(collection_arn:, field_mapping:, vector_index_name:) ⇒ OpenSearchServerlessConfigurationProperty

Returns a new instance of OpenSearchServerlessConfigurationProperty.

Parameters:

• collection_arn (String) —

  The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

• field_mapping (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty) —

  Contains the names of the fields to which to map information about the vector store.

• vector_index_name (String) —

  The name of the vector store.

# File 'bedrock/cfn_knowledge_base.rb', line 1453

def initialize(collection_arn:, field_mapping:, vector_index_name:)
  @collection_arn = collection_arn
  Jsii::Type.check_type(@collection_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionArn")
  @field_mapping = field_mapping.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty.new(**field_mapping.transform_keys(&:to_sym)) : field_mapping
  Jsii::Type.check_type(@field_mapping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuT3BlblNlYXJjaFNlcnZlcmxlc3NGaWVsZE1hcHBpbmdQcm9wZXJ0eSJ9XX19")), "fieldMapping")
  @vector_index_name = vector_index_name
  Jsii::Type.check_type(@vector_index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vectorIndexName")
end

Instance Attribute Details

#collection_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-collectionarn

# File 'bedrock/cfn_knowledge_base.rb', line 1466

def collection_arn
  @collection_arn
end

#field_mapping ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty (readonly)

Contains the names of the fields to which to map information about the vector store.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-fieldmapping

# File 'bedrock/cfn_knowledge_base.rb', line 1471

def field_mapping
  @field_mapping
end

#vector_index_name ⇒ String (readonly)

The name of the vector store.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-vectorindexname

# File 'bedrock/cfn_knowledge_base.rb', line 1476

def vector_index_name
  @vector_index_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1478

def self.jsii_properties
  {
    :collection_arn => "collectionArn",
    :field_mapping => "fieldMapping",
    :vector_index_name => "vectorIndexName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1486

def to_jsii
  result = {}
  result.merge!({
    "collectionArn" => @collection_arn,
    "fieldMapping" => @field_mapping,
    "vectorIndexName" => @vector_index_name,
  })
  result.compact
end