Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. KnowledgeBase

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.KnowledgeBase

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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:

    KnowledgeBaseConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    StorageConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseStorageConfiguration
    Contains details about the storage configuration of the knowledge base.
    Description string
    Description of the Resource.
    Name string
    The name of the knowledge base.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    KnowledgeBaseConfiguration KnowledgeBaseConfigurationArgs
    Contains details about the embeddings configuration of the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    StorageConfiguration KnowledgeBaseStorageConfigurationArgs
    Contains details about the storage configuration of the knowledge base.
    Description string
    Description of the Resource.
    Name string
    The name of the knowledge base.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    knowledgeBaseConfiguration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    storageConfiguration KnowledgeBaseStorageConfiguration
    Contains details about the storage configuration of the knowledge base.
    description String
    Description of the Resource.
    name String
    The name of the knowledge base.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    knowledgeBaseConfiguration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    roleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    storageConfiguration KnowledgeBaseStorageConfiguration
    Contains details about the storage configuration of the knowledge base.
    description string
    Description of the Resource.
    name string
    The name of the knowledge base.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    knowledge_base_configuration KnowledgeBaseConfigurationArgs
    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 KnowledgeBaseStorageConfigurationArgs
    Contains details about the storage configuration of the knowledge base.
    description str
    Description of the Resource.
    name str
    The name of the knowledge base.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    knowledgeBaseConfiguration Property Map
    Contains details about the embeddings configuration of the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    storageConfiguration 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.
    tags 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:

    CreatedAt string
    The time at which the knowledge base was created.
    FailureReasons 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.
    KnowledgeBaseArn string
    The ARN of the knowledge base.
    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    Status Pulumi.AwsNative.Bedrock.KnowledgeBaseStatus
    The status of the knowledge base.
    UpdatedAt string
    The time at which the knowledge base was last updated.
    CreatedAt string
    The time at which the knowledge base was created.
    FailureReasons []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.
    KnowledgeBaseArn string
    The ARN of the knowledge base.
    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    Status KnowledgeBaseStatus
    The status of the knowledge base.
    UpdatedAt string
    The time at which the knowledge base was last updated.
    createdAt String
    The time at which the knowledge base was created.
    failureReasons 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.
    knowledgeBaseArn String
    The ARN of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.
    status KnowledgeBaseStatus
    The status of the knowledge base.
    updatedAt String
    The time at which the knowledge base was last updated.
    createdAt string
    The time at which the knowledge base was created.
    failureReasons 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.
    knowledgeBaseArn string
    The ARN of the knowledge base.
    knowledgeBaseId string
    The unique identifier of the knowledge base.
    status KnowledgeBaseStatus
    The status of the knowledge base.
    updatedAt 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_arn str
    The ARN of the knowledge base.
    knowledge_base_id str
    The unique identifier of the knowledge base.
    status KnowledgeBaseStatus
    The status of the knowledge base.
    updated_at str
    The time at which the knowledge base was last updated.
    createdAt String
    The time at which the knowledge base was created.
    failureReasons 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.
    knowledgeBaseArn String
    The ARN of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.
    status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
    The status of the knowledge base.
    updatedAt 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.AwsNative.Bedrock.KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    VectorKnowledgeBaseConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    Type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    VectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    vectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    vectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    vector_knowledge_base_configuration KnowledgeBaseVectorKnowledgeBaseConfiguration
    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.
    vectorKnowledgeBaseConfiguration Property Map
    Contains details about the model that's used to convert the data source into vector embeddings.

    KnowledgeBaseEmbeddingModelConfiguration, KnowledgeBaseEmbeddingModelConfigurationArgs

    BedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrock_embedding_model_configuration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration Property Map
    The vector configuration details on the Bedrock embeddings model.

    KnowledgeBaseMongoDbAtlasConfiguration, KnowledgeBaseMongoDbAtlasConfigurationArgs

    CollectionName string
    Name of the collection within MongoDB Atlas.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
    DatabaseName string
    Name of the database within MongoDB Atlas.
    Endpoint string
    MongoDB Atlas endpoint.
    FieldMapping Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseMongoDbAtlasFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    VectorIndexName string
    Name of a MongoDB Atlas index.
    EndpointServiceName string
    MongoDB Atlas endpoint service name.
    CollectionName string
    Name of the collection within MongoDB Atlas.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
    DatabaseName string
    Name of the database within MongoDB Atlas.
    Endpoint string
    MongoDB Atlas endpoint.
    FieldMapping KnowledgeBaseMongoDbAtlasFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    VectorIndexName string
    Name of a MongoDB Atlas index.
    EndpointServiceName string
    MongoDB Atlas endpoint service name.
    collectionName String
    Name of the collection within MongoDB Atlas.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
    databaseName String
    Name of the database within MongoDB Atlas.
    endpoint String
    MongoDB Atlas endpoint.
    fieldMapping KnowledgeBaseMongoDbAtlasFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName String
    Name of a MongoDB Atlas index.
    endpointServiceName String
    MongoDB Atlas endpoint service name.
    collectionName string
    Name of the collection within MongoDB Atlas.
    credentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
    databaseName string
    Name of the database within MongoDB Atlas.
    endpoint string
    MongoDB Atlas endpoint.
    fieldMapping KnowledgeBaseMongoDbAtlasFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName string
    Name of a MongoDB Atlas index.
    endpointServiceName string
    MongoDB Atlas endpoint service name.
    collection_name str
    Name of the collection within MongoDB Atlas.
    credentials_secret_arn str
    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 KnowledgeBaseMongoDbAtlasFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vector_index_name str
    Name of a MongoDB Atlas index.
    endpoint_service_name str
    MongoDB Atlas endpoint service name.
    collectionName String
    Name of the collection within MongoDB Atlas.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database.
    databaseName String
    Name of the database within MongoDB Atlas.
    endpoint String
    MongoDB Atlas endpoint.
    fieldMapping Property Map
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName String
    Name of a MongoDB Atlas index.
    endpointServiceName String
    MongoDB Atlas endpoint service name.

    KnowledgeBaseMongoDbAtlasFieldMapping, KnowledgeBaseMongoDbAtlasFieldMappingArgs

    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField String
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField 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.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField String
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

    KnowledgeBaseOpenSearchServerlessConfiguration, KnowledgeBaseOpenSearchServerlessConfigurationArgs

    CollectionArn string
    The ARN of the OpenSearch Service vector store.
    FieldMapping Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseOpenSearchServerlessFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    VectorIndexName string
    The name of the vector store.
    CollectionArn string
    The ARN of the OpenSearch Service vector store.
    FieldMapping KnowledgeBaseOpenSearchServerlessFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    VectorIndexName string
    The name of the vector store.
    collectionArn String
    The ARN of the OpenSearch Service vector store.
    fieldMapping KnowledgeBaseOpenSearchServerlessFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName String
    The name of the vector store.
    collectionArn string
    The ARN of the OpenSearch Service vector store.
    fieldMapping KnowledgeBaseOpenSearchServerlessFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName string
    The name of the vector store.
    collection_arn str
    The ARN of the OpenSearch Service vector store.
    field_mapping KnowledgeBaseOpenSearchServerlessFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    vector_index_name str
    The name of the vector store.
    collectionArn String
    The ARN of the OpenSearch Service vector store.
    fieldMapping Property Map
    Contains the names of the fields to which to map information about the vector store.
    vectorIndexName String
    The name of the vector store.

    KnowledgeBaseOpenSearchServerlessFieldMapping, KnowledgeBaseOpenSearchServerlessFieldMappingArgs

    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField String
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField 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.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    vectorField String
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

    KnowledgeBasePineconeConfiguration, KnowledgeBasePineconeConfigurationArgs

    ConnectionString string
    The endpoint URL for your index management page.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    FieldMapping Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBasePineconeFieldMapping
    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.
    ConnectionString string
    The endpoint URL for your index management page.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    FieldMapping KnowledgeBasePineconeFieldMapping
    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.
    connectionString String
    The endpoint URL for your index management page.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    fieldMapping KnowledgeBasePineconeFieldMapping
    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.
    connectionString string
    The endpoint URL for your index management page.
    credentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    fieldMapping KnowledgeBasePineconeFieldMapping
    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_arn str
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    field_mapping KnowledgeBasePineconeFieldMapping
    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.
    connectionString String
    The endpoint URL for your index management page.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
    fieldMapping 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

    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    TextField 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.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    metadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    textField 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

    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
    DatabaseName string
    The name of your Amazon RDS database.
    FieldMapping Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRdsFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    ResourceArn string
    The ARN of the vector store.
    TableName string
    The name of the table in the database.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
    DatabaseName string
    The name of your Amazon RDS database.
    FieldMapping KnowledgeBaseRdsFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    ResourceArn string
    The ARN of the vector store.
    TableName string
    The name of the table in the database.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
    databaseName String
    The name of your Amazon RDS database.
    fieldMapping KnowledgeBaseRdsFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    resourceArn String
    The ARN of the vector store.
    tableName String
    The name of the table in the database.
    credentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
    databaseName string
    The name of your Amazon RDS database.
    fieldMapping KnowledgeBaseRdsFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    resourceArn string
    The ARN of the vector store.
    tableName string
    The name of the table in the database.
    credentials_secret_arn str
    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 KnowledgeBaseRdsFieldMapping
    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.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
    databaseName String
    The name of your Amazon RDS database.
    fieldMapping Property Map
    Contains the names of the fields to which to map information about the vector store.
    resourceArn String
    The ARN of the vector store.
    tableName String
    The name of the table in the database.

    KnowledgeBaseRdsFieldMapping, KnowledgeBaseRdsFieldMappingArgs

    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    PrimaryKeyField string
    The name of the field in which Amazon Bedrock stores the ID for each entry.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    MetadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    PrimaryKeyField string
    The name of the field in which Amazon Bedrock stores the ID for each entry.
    TextField 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.
    VectorField string
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    primaryKeyField String
    The name of the field in which Amazon Bedrock stores the ID for each entry.
    textField 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.
    vectorField String
    The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
    metadataField string
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    primaryKeyField string
    The name of the field in which Amazon Bedrock stores the ID for each entry.
    textField 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.
    vectorField 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_field str
    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.
    metadataField String
    The name of the field in which Amazon Bedrock stores metadata about the vector store.
    primaryKeyField String
    The name of the field in which Amazon Bedrock stores the ID for each entry.
    textField 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.
    vectorField 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
    DeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    KnowledgeBaseStatusCreating
    CREATING
    KnowledgeBaseStatusActive
    ACTIVE
    KnowledgeBaseStatusDeleting
    DELETING
    KnowledgeBaseStatusUpdating
    UPDATING
    KnowledgeBaseStatusFailed
    FAILED
    KnowledgeBaseStatusDeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Updating
    UPDATING
    Failed
    FAILED
    DeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Updating
    UPDATING
    Failed
    FAILED
    DeleteUnsuccessful
    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.AwsNative.Bedrock.KnowledgeBaseStorageType
    The vector store service in which the knowledge base is stored.
    MongoDbAtlasConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseMongoDbAtlasConfiguration
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    OpensearchServerlessConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseOpenSearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    PineconeConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBasePineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    RdsConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRdsConfiguration
    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 KnowledgeBaseStorageType
    The vector store service in which the knowledge base is stored.
    MongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    OpensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    PineconeConfiguration KnowledgeBasePineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    RdsConfiguration KnowledgeBaseRdsConfiguration
    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 KnowledgeBaseStorageType
    The vector store service in which the knowledge base is stored.
    mongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    opensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pineconeConfiguration KnowledgeBasePineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rdsConfiguration KnowledgeBaseRdsConfiguration
    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 KnowledgeBaseStorageType
    The vector store service in which the knowledge base is stored.
    mongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    opensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pineconeConfiguration KnowledgeBasePineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rdsConfiguration KnowledgeBaseRdsConfiguration
    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 KnowledgeBaseStorageType
    The vector store service in which the knowledge base is stored.
    mongo_db_atlas_configuration KnowledgeBaseMongoDbAtlasConfiguration
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    opensearch_serverless_configuration KnowledgeBaseOpenSearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pinecone_configuration KnowledgeBasePineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rds_configuration KnowledgeBaseRdsConfiguration
    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.
    mongoDbAtlasConfiguration Property Map
    Contains the storage configuration of the knowledge base in MongoDB Atlas.
    opensearchServerlessConfiguration Property Map
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pineconeConfiguration Property Map
    Contains the storage configuration of the knowledge base in Pinecone.
    rdsConfiguration 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

    OpensearchServerless
    OPENSEARCH_SERVERLESS
    Pinecone
    PINECONE
    Rds
    RDS
    MongoDbAtlas
    MONGO_DB_ATLAS
    KnowledgeBaseStorageTypeOpensearchServerless
    OPENSEARCH_SERVERLESS
    KnowledgeBaseStorageTypePinecone
    PINECONE
    KnowledgeBaseStorageTypeRds
    RDS
    KnowledgeBaseStorageTypeMongoDbAtlas
    MONGO_DB_ATLAS
    OpensearchServerless
    OPENSEARCH_SERVERLESS
    Pinecone
    PINECONE
    Rds
    RDS
    MongoDbAtlas
    MONGO_DB_ATLAS
    OpensearchServerless
    OPENSEARCH_SERVERLESS
    Pinecone
    PINECONE
    Rds
    RDS
    MongoDbAtlas
    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
    KnowledgeBaseTypeVector
    VECTOR
    Vector
    VECTOR
    Vector
    VECTOR
    VECTOR
    VECTOR
    "VECTOR"
    VECTOR

    KnowledgeBaseVectorKnowledgeBaseConfiguration, KnowledgeBaseVectorKnowledgeBaseConfigurationArgs

    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    EmbeddingModelConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    EmbeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    embeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    embedding_model_arn str
    The ARN of the model used to create vector embeddings for the knowledge base.
    embedding_model_configuration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration Property Map
    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
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native