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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

class MongoDbAtlasConfiguration < Struct.new(
  :collection_name,
  :credentials_secret_arn,
  :database_name,
  :endpoint,
  :endpoint_service_name,
  :field_mapping,
  :vector_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) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

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

#database_name ⇒ String

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

Returns:

  • (String) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

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

#endpoint ⇒ String

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

Returns:

  • (String) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

class MongoDbAtlasConfiguration < Struct.new(
  :collection_name,
  :credentials_secret_arn,
  :database_name,
  :endpoint,
  :endpoint_service_name,
  :field_mapping,
  :vector_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) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

class MongoDbAtlasConfiguration < Struct.new(
  :collection_name,
  :credentials_secret_arn,
  :database_name,
  :endpoint,
  :endpoint_service_name,
  :field_mapping,
  :vector_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:



2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

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

#vector_index_name ⇒ String

The name of the MongoDB Atlas vector search index.

Returns:

  • (String) 


2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 2971

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