We recommend new projects start with resources from the AWS provider.
aws-native.bedrock.KnowledgeBase
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Bedrock::KnowledgeBase Resource Type
Create KnowledgeBase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KnowledgeBase(name: string, args: KnowledgeBaseArgs, opts?: CustomResourceOptions);
@overload
def KnowledgeBase(resource_name: str,
args: KnowledgeBaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KnowledgeBase(resource_name: str,
opts: Optional[ResourceOptions] = None,
knowledge_base_configuration: Optional[KnowledgeBaseConfigurationArgs] = None,
role_arn: Optional[str] = None,
storage_configuration: Optional[KnowledgeBaseStorageConfigurationArgs] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewKnowledgeBase(ctx *Context, name string, args KnowledgeBaseArgs, opts ...ResourceOption) (*KnowledgeBase, error)
public KnowledgeBase(string name, KnowledgeBaseArgs args, CustomResourceOptions? opts = null)
public KnowledgeBase(String name, KnowledgeBaseArgs args)
public KnowledgeBase(String name, KnowledgeBaseArgs args, CustomResourceOptions options)
type: aws-native:bedrock:KnowledgeBase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
KnowledgeBase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The KnowledgeBase resource accepts the following input properties:
- Knowledge
Base Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Configuration - Contains details about the embeddings configuration of the knowledge base.
- Role
Arn string - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- Storage
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Storage Configuration - Contains details about the storage configuration of the knowledge base.
- Description string
- Description of the Resource.
- Name string
- The name of the knowledge base.
- Dictionary<string, string>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Knowledge
Base KnowledgeConfiguration Base Configuration Args - Contains details about the embeddings configuration of the knowledge base.
- Role
Arn string - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- Storage
Configuration KnowledgeBase Storage Configuration Args - Contains details about the storage configuration of the knowledge base.
- Description string
- Description of the Resource.
- Name string
- The name of the knowledge base.
- map[string]string
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base KnowledgeConfiguration Base Configuration - Contains details about the embeddings configuration of the knowledge base.
- role
Arn String - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- storage
Configuration KnowledgeBase Storage Configuration - Contains details about the storage configuration of the knowledge base.
- description String
- Description of the Resource.
- name String
- The name of the knowledge base.
- Map<String,String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base KnowledgeConfiguration Base Configuration - Contains details about the embeddings configuration of the knowledge base.
- role
Arn string - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- storage
Configuration KnowledgeBase Storage Configuration - Contains details about the storage configuration of the knowledge base.
- description string
- Description of the Resource.
- name string
- The name of the knowledge base.
- {[key: string]: string}
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge_
base_ Knowledgeconfiguration Base Configuration Args - Contains details about the embeddings configuration of the knowledge base.
- role_
arn str - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- storage_
configuration KnowledgeBase Storage Configuration Args - Contains details about the storage configuration of the knowledge base.
- description str
- Description of the Resource.
- name str
- The name of the knowledge base.
- Mapping[str, str]
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base Property MapConfiguration - Contains details about the embeddings configuration of the knowledge base.
- role
Arn String - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- storage
Configuration Property Map - Contains details about the storage configuration of the knowledge base.
- description String
- Description of the Resource.
- name String
- The name of the knowledge base.
- Map<String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
Outputs
All input properties are implicitly available as output properties. Additionally, the KnowledgeBase resource produces the following output properties:
- Created
At string - The time at which the knowledge base was created.
- Failure
Reasons List<string> - A list of reasons that the API operation on the knowledge base failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Status
Pulumi.
Aws Native. Bedrock. Knowledge Base Status - The status of the knowledge base.
- Updated
At string - The time at which the knowledge base was last updated.
- Created
At string - The time at which the knowledge base was created.
- Failure
Reasons []string - A list of reasons that the API operation on the knowledge base failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Status
Knowledge
Base Status - The status of the knowledge base.
- Updated
At string - The time at which the knowledge base was last updated.
- created
At String - The time at which the knowledge base was created.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated
At String - The time at which the knowledge base was last updated.
- created
At string - The time at which the knowledge base was created.
- failure
Reasons string[] - A list of reasons that the API operation on the knowledge base failed.
- id string
- The provider-assigned unique ID for this managed resource.
- knowledge
Base stringArn - The ARN of the knowledge base.
- knowledge
Base stringId - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated
At string - The time at which the knowledge base was last updated.
- created_
at str - The time at which the knowledge base was created.
- failure_
reasons Sequence[str] - A list of reasons that the API operation on the knowledge base failed.
- id str
- The provider-assigned unique ID for this managed resource.
- knowledge_
base_ strarn - The ARN of the knowledge base.
- knowledge_
base_ strid - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated_
at str - The time at which the knowledge base was last updated.
- created
At String - The time at which the knowledge base was created.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
- The status of the knowledge base.
- updated
At String - The time at which the knowledge base was last updated.
Supporting Types
KnowledgeBaseBedrockEmbeddingModelConfiguration, KnowledgeBaseBedrockEmbeddingModelConfigurationArgs
- Dimensions int
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- Dimensions int
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- dimensions Integer
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- dimensions number
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- dimensions int
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- dimensions Number
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
KnowledgeBaseConfiguration, KnowledgeBaseConfigurationArgs
- Type
Pulumi.
Aws Native. Bedrock. Knowledge Base Type - The type of data that the data source is converted into for the knowledge base.
- Vector
Knowledge Pulumi.Base Configuration Aws Native. Bedrock. Inputs. Knowledge Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- Type
Knowledge
Base Type - The type of data that the data source is converted into for the knowledge base.
- Vector
Knowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- type
Knowledge
Base Type - The type of data that the data source is converted into for the knowledge base.
- vector
Knowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- type
Knowledge
Base Type - The type of data that the data source is converted into for the knowledge base.
- vector
Knowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- type
Knowledge
Base Type - The type of data that the data source is converted into for the knowledge base.
- vector_
knowledge_ Knowledgebase_ configuration Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- type "VECTOR"
- The type of data that the data source is converted into for the knowledge base.
- vector
Knowledge Property MapBase Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
KnowledgeBaseEmbeddingModelConfiguration, KnowledgeBaseEmbeddingModelConfigurationArgs
- Bedrock
Embedding Pulumi.Model Configuration Aws Native. Bedrock. Inputs. Knowledge Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- Bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock_
embedding_ Knowledgemodel_ configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding Property MapModel Configuration - The vector configuration details on the Bedrock embeddings model.
KnowledgeBaseMongoDbAtlasConfiguration, KnowledgeBaseMongoDbAtlasConfigurationArgs
- Collection
Name string - Name of the collection within MongoDB Atlas.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- Database
Name string - Name of the database within MongoDB Atlas.
- Endpoint string
- MongoDB Atlas endpoint.
- Field
Mapping Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index stringName - Name of a MongoDB Atlas index.
- Endpoint
Service stringName - MongoDB Atlas endpoint service name.
- Collection
Name string - Name of the collection within MongoDB Atlas.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- Database
Name string - Name of the database within MongoDB Atlas.
- Endpoint string
- MongoDB Atlas endpoint.
- Field
Mapping KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index stringName - Name of a MongoDB Atlas index.
- Endpoint
Service stringName - MongoDB Atlas endpoint service name.
- collection
Name String - Name of the collection within MongoDB Atlas.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- database
Name String - Name of the database within MongoDB Atlas.
- endpoint String
- MongoDB Atlas endpoint.
- field
Mapping KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index StringName - Name of a MongoDB Atlas index.
- endpoint
Service StringName - MongoDB Atlas endpoint service name.
- collection
Name string - Name of the collection within MongoDB Atlas.
- credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- database
Name string - Name of the database within MongoDB Atlas.
- endpoint string
- MongoDB Atlas endpoint.
- field
Mapping KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index stringName - Name of a MongoDB Atlas index.
- endpoint
Service stringName - MongoDB Atlas endpoint service name.
- collection_
name str - Name of the collection within MongoDB Atlas.
- credentials_
secret_ strarn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- database_
name str - Name of the database within MongoDB Atlas.
- endpoint str
- MongoDB Atlas endpoint.
- field_
mapping KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector_
index_ strname - Name of a MongoDB Atlas index.
- endpoint_
service_ strname - MongoDB Atlas endpoint service name.
- collection
Name String - Name of the collection within MongoDB Atlas.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
- database
Name String - Name of the database within MongoDB Atlas.
- endpoint String
- MongoDB Atlas endpoint.
- field
Mapping Property Map - Contains the names of the fields to which to map information about the vector store.
- vector
Index StringName - Name of a MongoDB Atlas index.
- endpoint
Service StringName - MongoDB Atlas endpoint service name.
KnowledgeBaseMongoDbAtlasFieldMapping, KnowledgeBaseMongoDbAtlasFieldMappingArgs
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector_
field str - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBaseOpenSearchServerlessConfiguration, KnowledgeBaseOpenSearchServerlessConfigurationArgs
- Collection
Arn string - The ARN of the OpenSearch Service vector store.
- Field
Mapping Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index stringName - The name of the vector store.
- Collection
Arn string - The ARN of the OpenSearch Service vector store.
- Field
Mapping KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index stringName - The name of the vector store.
- collection
Arn String - The ARN of the OpenSearch Service vector store.
- field
Mapping KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index StringName - The name of the vector store.
- collection
Arn string - The ARN of the OpenSearch Service vector store.
- field
Mapping KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index stringName - The name of the vector store.
- collection_
arn str - The ARN of the OpenSearch Service vector store.
- field_
mapping KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector_
index_ strname - The name of the vector store.
- collection
Arn String - The ARN of the OpenSearch Service vector store.
- field
Mapping Property Map - Contains the names of the fields to which to map information about the vector store.
- vector
Index StringName - The name of the vector store.
KnowledgeBaseOpenSearchServerlessFieldMapping, KnowledgeBaseOpenSearchServerlessFieldMappingArgs
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector_
field str - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBasePineconeConfiguration, KnowledgeBasePineconeConfigurationArgs
- Connection
String string - The endpoint URL for your index management page.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- Field
Mapping Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Namespace string
- The namespace to be used to write new data to your database.
- Connection
String string - The endpoint URL for your index management page.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- Field
Mapping KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Namespace string
- The namespace to be used to write new data to your database.
- connection
String String - The endpoint URL for your index management page.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace String
- The namespace to be used to write new data to your database.
- connection
String string - The endpoint URL for your index management page.
- credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace string
- The namespace to be used to write new data to your database.
- connection_
string str - The endpoint URL for your index management page.
- credentials_
secret_ strarn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field_
mapping KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace str
- The namespace to be used to write new data to your database.
- connection
String String - The endpoint URL for your index management page.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping Property Map - Contains the names of the fields to which to map information about the vector store.
- namespace String
- The namespace to be used to write new data to your database.
KnowledgeBasePineconeFieldMapping, KnowledgeBasePineconeFieldMappingArgs
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata_
field str - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
KnowledgeBaseRdsConfiguration, KnowledgeBaseRdsConfigurationArgs
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- Database
Name string - The name of your Amazon RDS database.
- Field
Mapping Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Resource
Arn string - The ARN of the vector store.
- Table
Name string - The name of the table in the database.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- Database
Name string - The name of your Amazon RDS database.
- Field
Mapping KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Resource
Arn string - The ARN of the vector store.
- Table
Name string - The name of the table in the database.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name String - The name of your Amazon RDS database.
- field
Mapping KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- resource
Arn String - The ARN of the vector store.
- table
Name String - The name of the table in the database.
- credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name string - The name of your Amazon RDS database.
- field
Mapping KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- resource
Arn string - The ARN of the vector store.
- table
Name string - The name of the table in the database.
- credentials_
secret_ strarn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database_
name str - The name of your Amazon RDS database.
- field_
mapping KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- resource_
arn str - The ARN of the vector store.
- table_
name str - The name of the table in the database.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name String - The name of your Amazon RDS database.
- field
Mapping Property Map - Contains the names of the fields to which to map information about the vector store.
- resource
Arn String - The ARN of the vector store.
- table
Name String - The name of the table in the database.
KnowledgeBaseRdsFieldMapping, KnowledgeBaseRdsFieldMappingArgs
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key stringField - The name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key stringField - The name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key StringField - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key stringField - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary_
key_ strfield - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text_
field str - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector_
field str - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key StringField - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBaseStatus, KnowledgeBaseStatusArgs
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Updating
- UPDATING
- Failed
- FAILED
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Knowledge
Base Status Creating - CREATING
- Knowledge
Base Status Active - ACTIVE
- Knowledge
Base Status Deleting - DELETING
- Knowledge
Base Status Updating - UPDATING
- Knowledge
Base Status Failed - FAILED
- Knowledge
Base Status Delete Unsuccessful - DELETE_UNSUCCESSFUL
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Updating
- UPDATING
- Failed
- FAILED
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Updating
- UPDATING
- Failed
- FAILED
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- CREATING
- CREATING
- ACTIVE
- ACTIVE
- DELETING
- DELETING
- UPDATING
- UPDATING
- FAILED
- FAILED
- DELETE_UNSUCCESSFUL
- DELETE_UNSUCCESSFUL
- "CREATING"
- CREATING
- "ACTIVE"
- ACTIVE
- "DELETING"
- DELETING
- "UPDATING"
- UPDATING
- "FAILED"
- FAILED
- "DELETE_UNSUCCESSFUL"
- DELETE_UNSUCCESSFUL
KnowledgeBaseStorageConfiguration, KnowledgeBaseStorageConfigurationArgs
- Type
Pulumi.
Aws Native. Bedrock. Knowledge Base Storage Type - The vector store service in which the knowledge base is stored.
- Mongo
Db Pulumi.Atlas Configuration Aws Native. Bedrock. Inputs. Knowledge Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- Opensearch
Serverless Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- Pinecone
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- Rds
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- Type
Knowledge
Base Storage Type - The vector store service in which the knowledge base is stored.
- Mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- Opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- Pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- Rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
Knowledge
Base Storage Type - The vector store service in which the knowledge base is stored.
- mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
Knowledge
Base Storage Type - The vector store service in which the knowledge base is stored.
- mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
Knowledge
Base Storage Type - The vector store service in which the knowledge base is stored.
- mongo_
db_ Knowledgeatlas_ configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch_
serverless_ Knowledgeconfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone_
configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds_
configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS"
- The vector store service in which the knowledge base is stored.
- mongo
Db Property MapAtlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless Property MapConfiguration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration Property Map - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration Property Map - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
KnowledgeBaseStorageType, KnowledgeBaseStorageTypeArgs
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- Knowledge
Base Storage Type Opensearch Serverless - OPENSEARCH_SERVERLESS
- Knowledge
Base Storage Type Pinecone - PINECONE
- Knowledge
Base Storage Type Rds - RDS
- Knowledge
Base Storage Type Mongo Db Atlas - MONGO_DB_ATLAS
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- OPENSEARCH_SERVERLESS
- OPENSEARCH_SERVERLESS
- PINECONE
- PINECONE
- RDS
- RDS
- MONGO_DB_ATLAS
- MONGO_DB_ATLAS
- "OPENSEARCH_SERVERLESS"
- OPENSEARCH_SERVERLESS
- "PINECONE"
- PINECONE
- "RDS"
- RDS
- "MONGO_DB_ATLAS"
- MONGO_DB_ATLAS
KnowledgeBaseType, KnowledgeBaseTypeArgs
- Vector
- VECTOR
- Knowledge
Base Type Vector - VECTOR
- Vector
- VECTOR
- Vector
- VECTOR
- VECTOR
- VECTOR
- "VECTOR"
- VECTOR
KnowledgeBaseVectorKnowledgeBaseConfiguration, KnowledgeBaseVectorKnowledgeBaseConfigurationArgs
- Embedding
Model stringArn - The ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- Embedding
Model stringArn - The ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- embedding
Model StringArn - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- embedding
Model stringArn - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- embedding_
model_ strarn - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding_
model_ Knowledgeconfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- embedding
Model StringArn - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model Property MapConfiguration - The embeddings model configuration details for the vector model used in Knowledge Base.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.