Class: Aws::BedrockAgent::Types::MongoDbAtlasConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_name ⇒ String

The collection name of the knowledge base in MongoDB Atlas.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The database name in your MongoDB Atlas cluster for your knowledge base.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_service_name ⇒ String

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#field_mapping ⇒ Types::MongoDbAtlasFieldMapping

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

Returns:



8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#text_index_name ⇒ String

The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end

#vector_index_name ⇒ String

The name of the MongoDB Atlas vector search index.

Returns:

  • (String) 


8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 8013

class MongoDbAtlasConfiguration < Struct.new(
  :endpoint,
  :database_name,
  :collection_name,
  :vector_index_name,
  :credentials_secret_arn,
  :field_mapping,
  :endpoint_service_name,
  :text_index_name)
  SENSITIVE = []
  include Aws::Structure
end