Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. bedrock
  5. AgentKnowledgeBase

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi
pulumi/pulumi-aws

aws.bedrock.AgentKnowledgeBase

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Agents for Amazon Bedrock Knowledge Base.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.bedrock.AgentKnowledgeBase("test", {
    name: "example",
    roleArn: example.arn,
    knowledgeBaseConfiguration: {
        vectorKnowledgeBaseConfiguration: {
            embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1",
        },
        type: "VECTOR",
    },
    storageConfiguration: {
        type: "OPENSEARCH_SERVERLESS",
        opensearchServerlessConfiguration: {
            collectionArn: "arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf",
            vectorIndexName: "bedrock-knowledge-base-default-index",
            fieldMapping: {
                vectorField: "bedrock-knowledge-base-default-vector",
                textField: "AMAZON_BEDROCK_TEXT_CHUNK",
                metadataField: "AMAZON_BEDROCK_METADATA",
            },
        },
    },
});

    import pulumi
import pulumi_aws as aws

test = aws.bedrock.AgentKnowledgeBase("test",
    name="example",
    role_arn=example["arn"],
    knowledge_base_configuration=aws.bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs(
        vector_knowledge_base_configuration=aws.bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs(
            embedding_model_arn="arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1",
        ),
        type="VECTOR",
    ),
    storage_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationArgs(
        type="OPENSEARCH_SERVERLESS",
        opensearch_serverless_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs(
            collection_arn="arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf",
            vector_index_name="bedrock-knowledge-base-default-index",
            field_mapping=aws.bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs(
                vector_field="bedrock-knowledge-base-default-vector",
                text_field="AMAZON_BEDROCK_TEXT_CHUNK",
                metadata_field="AMAZON_BEDROCK_METADATA",
            ),
        ),
    ))

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentKnowledgeBase(ctx, "test", &bedrock.AgentKnowledgeBaseArgs{
			Name:    pulumi.String("example"),
			RoleArn: pulumi.Any(example.Arn),
			KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
				VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
					EmbeddingModelArn: pulumi.String("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1"),
				},
				Type: pulumi.String("VECTOR"),
			},
			StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
				Type: pulumi.String("OPENSEARCH_SERVERLESS"),
				OpensearchServerlessConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs{
					CollectionArn:   pulumi.String("arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf"),
					VectorIndexName: pulumi.String("bedrock-knowledge-base-default-index"),
					FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs{
						VectorField:   pulumi.String("bedrock-knowledge-base-default-vector"),
						TextField:     pulumi.String("AMAZON_BEDROCK_TEXT_CHUNK"),
						MetadataField: pulumi.String("AMAZON_BEDROCK_METADATA"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Bedrock.AgentKnowledgeBase("test", new()
    {
        Name = "example",
        RoleArn = example.Arn,
        KnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
        {
            VectorKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs
            {
                EmbeddingModelArn = "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1",
            },
            Type = "VECTOR",
        },
        StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
        {
            Type = "OPENSEARCH_SERVERLESS",
            OpensearchServerlessConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs
            {
                CollectionArn = "arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf",
                VectorIndexName = "bedrock-knowledge-base-default-index",
                FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs
                {
                    VectorField = "bedrock-knowledge-base-default-vector",
                    TextField = "AMAZON_BEDROCK_TEXT_CHUNK",
                    MetadataField = "AMAZON_BEDROCK_METADATA",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentKnowledgeBase;
import com.pulumi.aws.bedrock.AgentKnowledgeBaseArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new AgentKnowledgeBase("test", AgentKnowledgeBaseArgs.builder()        
            .name("example")
            .roleArn(example.arn())
            .knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
                .vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
                    .embeddingModelArn("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1")
                    .build())
                .type("VECTOR")
                .build())
            .storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
                .type("OPENSEARCH_SERVERLESS")
                .opensearchServerlessConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs.builder()
                    .collectionArn("arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf")
                    .vectorIndexName("bedrock-knowledge-base-default-index")
                    .fieldMapping(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs.builder()
                        .vectorField("bedrock-knowledge-base-default-vector")
                        .textField("AMAZON_BEDROCK_TEXT_CHUNK")
                        .metadataField("AMAZON_BEDROCK_METADATA")
                        .build())
                    .build())
                .build())
            .build());

    }
}

    resources:
  test:
    type: aws:bedrock:AgentKnowledgeBase
    properties:
      name: example
      roleArn: ${example.arn}
      knowledgeBaseConfiguration:
        vectorKnowledgeBaseConfiguration:
          embeddingModelArn: arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v1
        type: VECTOR
      storageConfiguration:
        type: OPENSEARCH_SERVERLESS
        opensearchServerlessConfiguration:
          collectionArn: arn:aws:aoss:us-west-2:1234567890:collection/142bezjddq707i5stcrf
          vectorIndexName: bedrock-knowledge-base-default-index
          fieldMapping:
            vectorField: bedrock-knowledge-base-default-vector
            textField: AMAZON_BEDROCK_TEXT_CHUNK
            metadataField: AMAZON_BEDROCK_METADATA

    Create AgentKnowledgeBase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentKnowledgeBase(name: string, args: AgentKnowledgeBaseArgs, opts?: CustomResourceOptions);
    @overload
def AgentKnowledgeBase(resource_name: str,
                       args: AgentKnowledgeBaseArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def AgentKnowledgeBase(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       role_arn: Optional[str] = None,
                       description: Optional[str] = None,
                       knowledge_base_configuration: Optional[AgentKnowledgeBaseKnowledgeBaseConfigurationArgs] = None,
                       name: Optional[str] = None,
                       storage_configuration: Optional[AgentKnowledgeBaseStorageConfigurationArgs] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       timeouts: Optional[AgentKnowledgeBaseTimeoutsArgs] = None)
    func NewAgentKnowledgeBase(ctx *Context, name string, args AgentKnowledgeBaseArgs, opts ...ResourceOption) (*AgentKnowledgeBase, error)
    public AgentKnowledgeBase(string name, AgentKnowledgeBaseArgs args, CustomResourceOptions? opts = null)
    public AgentKnowledgeBase(String name, AgentKnowledgeBaseArgs args)
public AgentKnowledgeBase(String name, AgentKnowledgeBaseArgs args, CustomResourceOptions options)

    type: aws:bedrock:AgentKnowledgeBase
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 AgentKnowledgeBaseArgs
    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 AgentKnowledgeBaseArgs
    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 AgentKnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentKnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentKnowledgeBaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var agentKnowledgeBaseResource = new Aws.Bedrock.AgentKnowledgeBase("agentKnowledgeBaseResource", new()
{
    RoleArn = "string",
    Description = "string",
    KnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
    {
        Type = "string",
        VectorKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs
        {
            EmbeddingModelArn = "string",
        },
    },
    Name = "string",
    StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
    {
        Type = "string",
        OpensearchServerlessConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs
        {
            CollectionArn = "string",
            VectorIndexName = "string",
            FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs
            {
                MetadataField = "string",
                TextField = "string",
                VectorField = "string",
            },
        },
        PineconeConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs
        {
            ConnectionString = "string",
            CredentialsSecretArn = "string",
            FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs
            {
                MetadataField = "string",
                TextField = "string",
            },
            Namespace = "string",
        },
        RdsConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationRdsConfigurationArgs
        {
            CredentialsSecretArn = "string",
            DatabaseName = "string",
            ResourceArn = "string",
            TableName = "string",
            FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs
            {
                MetadataField = "string",
                PrimaryKeyField = "string",
                TextField = "string",
                VectorField = "string",
            },
        },
        RedisEnterpriseCloudConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs
        {
            CredentialsSecretArn = "string",
            Endpoint = "string",
            VectorIndexName = "string",
            FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs
            {
                MetadataField = "string",
                TextField = "string",
                VectorField = "string",
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Bedrock.Inputs.AgentKnowledgeBaseTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := bedrock.NewAgentKnowledgeBase(ctx, "agentKnowledgeBaseResource", &bedrock.AgentKnowledgeBaseArgs{
	RoleArn:     pulumi.String("string"),
	Description: pulumi.String("string"),
	KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
		Type: pulumi.String("string"),
		VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
			EmbeddingModelArn: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
		Type: pulumi.String("string"),
		OpensearchServerlessConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs{
			CollectionArn:   pulumi.String("string"),
			VectorIndexName: pulumi.String("string"),
			FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs{
				MetadataField: pulumi.String("string"),
				TextField:     pulumi.String("string"),
				VectorField:   pulumi.String("string"),
			},
		},
		PineconeConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs{
			ConnectionString:     pulumi.String("string"),
			CredentialsSecretArn: pulumi.String("string"),
			FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs{
				MetadataField: pulumi.String("string"),
				TextField:     pulumi.String("string"),
			},
			Namespace: pulumi.String("string"),
		},
		RdsConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationRdsConfigurationArgs{
			CredentialsSecretArn: pulumi.String("string"),
			DatabaseName:         pulumi.String("string"),
			ResourceArn:          pulumi.String("string"),
			TableName:            pulumi.String("string"),
			FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs{
				MetadataField:   pulumi.String("string"),
				PrimaryKeyField: pulumi.String("string"),
				TextField:       pulumi.String("string"),
				VectorField:     pulumi.String("string"),
			},
		},
		RedisEnterpriseCloudConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs{
			CredentialsSecretArn: pulumi.String("string"),
			Endpoint:             pulumi.String("string"),
			VectorIndexName:      pulumi.String("string"),
			FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs{
				MetadataField: pulumi.String("string"),
				TextField:     pulumi.String("string"),
				VectorField:   pulumi.String("string"),
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &bedrock.AgentKnowledgeBaseTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var agentKnowledgeBaseResource = new AgentKnowledgeBase("agentKnowledgeBaseResource", AgentKnowledgeBaseArgs.builder()        
    .roleArn("string")
    .description("string")
    .knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
        .type("string")
        .vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
            .embeddingModelArn("string")
            .build())
        .build())
    .name("string")
    .storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
        .type("string")
        .opensearchServerlessConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs.builder()
            .collectionArn("string")
            .vectorIndexName("string")
            .fieldMapping(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs.builder()
                .metadataField("string")
                .textField("string")
                .vectorField("string")
                .build())
            .build())
        .pineconeConfiguration(AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs.builder()
            .connectionString("string")
            .credentialsSecretArn("string")
            .fieldMapping(AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs.builder()
                .metadataField("string")
                .textField("string")
                .build())
            .namespace("string")
            .build())
        .rdsConfiguration(AgentKnowledgeBaseStorageConfigurationRdsConfigurationArgs.builder()
            .credentialsSecretArn("string")
            .databaseName("string")
            .resourceArn("string")
            .tableName("string")
            .fieldMapping(AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs.builder()
                .metadataField("string")
                .primaryKeyField("string")
                .textField("string")
                .vectorField("string")
                .build())
            .build())
        .redisEnterpriseCloudConfiguration(AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs.builder()
            .credentialsSecretArn("string")
            .endpoint("string")
            .vectorIndexName("string")
            .fieldMapping(AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs.builder()
                .metadataField("string")
                .textField("string")
                .vectorField("string")
                .build())
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .timeouts(AgentKnowledgeBaseTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    agent_knowledge_base_resource = aws.bedrock.AgentKnowledgeBase("agentKnowledgeBaseResource",
    role_arn="string",
    description="string",
    knowledge_base_configuration=aws.bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs(
        type="string",
        vector_knowledge_base_configuration=aws.bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs(
            embedding_model_arn="string",
        ),
    ),
    name="string",
    storage_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationArgs(
        type="string",
        opensearch_serverless_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs(
            collection_arn="string",
            vector_index_name="string",
            field_mapping=aws.bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs(
                metadata_field="string",
                text_field="string",
                vector_field="string",
            ),
        ),
        pinecone_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs(
            connection_string="string",
            credentials_secret_arn="string",
            field_mapping=aws.bedrock.AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs(
                metadata_field="string",
                text_field="string",
            ),
            namespace="string",
        ),
        rds_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationRdsConfigurationArgs(
            credentials_secret_arn="string",
            database_name="string",
            resource_arn="string",
            table_name="string",
            field_mapping=aws.bedrock.AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs(
                metadata_field="string",
                primary_key_field="string",
                text_field="string",
                vector_field="string",
            ),
        ),
        redis_enterprise_cloud_configuration=aws.bedrock.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs(
            credentials_secret_arn="string",
            endpoint="string",
            vector_index_name="string",
            field_mapping=aws.bedrock.AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs(
                metadata_field="string",
                text_field="string",
                vector_field="string",
            ),
        ),
    ),
    tags={
        "string": "string",
    },
    timeouts=aws.bedrock.AgentKnowledgeBaseTimeoutsArgs(
        create="string",
        delete="string",
        update="string",
    ))

    const agentKnowledgeBaseResource = new aws.bedrock.AgentKnowledgeBase("agentKnowledgeBaseResource", {
    roleArn: "string",
    description: "string",
    knowledgeBaseConfiguration: {
        type: "string",
        vectorKnowledgeBaseConfiguration: {
            embeddingModelArn: "string",
        },
    },
    name: "string",
    storageConfiguration: {
        type: "string",
        opensearchServerlessConfiguration: {
            collectionArn: "string",
            vectorIndexName: "string",
            fieldMapping: {
                metadataField: "string",
                textField: "string",
                vectorField: "string",
            },
        },
        pineconeConfiguration: {
            connectionString: "string",
            credentialsSecretArn: "string",
            fieldMapping: {
                metadataField: "string",
                textField: "string",
            },
            namespace: "string",
        },
        rdsConfiguration: {
            credentialsSecretArn: "string",
            databaseName: "string",
            resourceArn: "string",
            tableName: "string",
            fieldMapping: {
                metadataField: "string",
                primaryKeyField: "string",
                textField: "string",
                vectorField: "string",
            },
        },
        redisEnterpriseCloudConfiguration: {
            credentialsSecretArn: "string",
            endpoint: "string",
            vectorIndexName: "string",
            fieldMapping: {
                metadataField: "string",
                textField: "string",
                vectorField: "string",
            },
        },
    },
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:bedrock:AgentKnowledgeBase
properties:
    description: string
    knowledgeBaseConfiguration:
        type: string
        vectorKnowledgeBaseConfiguration:
            embeddingModelArn: string
    name: string
    roleArn: string
    storageConfiguration:
        opensearchServerlessConfiguration:
            collectionArn: string
            fieldMapping:
                metadataField: string
                textField: string
                vectorField: string
            vectorIndexName: string
        pineconeConfiguration:
            connectionString: string
            credentialsSecretArn: string
            fieldMapping:
                metadataField: string
                textField: string
            namespace: string
        rdsConfiguration:
            credentialsSecretArn: string
            databaseName: string
            fieldMapping:
                metadataField: string
                primaryKeyField: string
                textField: string
                vectorField: string
            resourceArn: string
            tableName: string
        redisEnterpriseCloudConfiguration:
            credentialsSecretArn: string
            endpoint: string
            fieldMapping:
                metadataField: string
                textField: string
                vectorField: string
            vectorIndexName: string
        type: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

    AgentKnowledgeBase 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 AgentKnowledgeBase resource accepts the following input properties:

    RoleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    Description string
    A description of the knowledge base.
    KnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    Name string
    A name for the knowledge base.
    StorageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts AgentKnowledgeBaseTimeouts
    RoleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    Description string
    A description of the knowledge base.
    KnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
    Contains details about the embeddings model used for the knowledge base.
    Name string
    A name for the knowledge base.
    StorageConfiguration AgentKnowledgeBaseStorageConfigurationArgs
    Contains details about the configuration of the vector database used for the knowledge base.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts AgentKnowledgeBaseTimeoutsArgs
    roleArn String
    The ARN of the IAM role with permissions to create the knowledge base.
    description String
    A description of the knowledge base.
    knowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    name String
    A name for the knowledge base.
    storageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts AgentKnowledgeBaseTimeouts
    roleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    description string
    A description of the knowledge base.
    knowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    name string
    A name for the knowledge base.
    storageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts AgentKnowledgeBaseTimeouts
    role_arn str
    The ARN of the IAM role with permissions to create the knowledge base.
    description str
    A description of the knowledge base.
    knowledge_base_configuration AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
    Contains details about the embeddings model used for the knowledge base.
    name str
    A name for the knowledge base.
    storage_configuration AgentKnowledgeBaseStorageConfigurationArgs
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts AgentKnowledgeBaseTimeoutsArgs
    roleArn String
    The ARN of the IAM role with permissions to create the knowledge base.
    description String
    A description of the knowledge base.
    knowledgeBaseConfiguration Property Map
    Contains details about the embeddings model used for the knowledge base.
    name String
    A name for the knowledge base.
    storageConfiguration Property Map
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentKnowledgeBase resource produces the following output properties:

    Arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    CreatedAt string
    FailureReasons List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    UpdatedAt string
    Arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    CreatedAt string
    FailureReasons []string
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    UpdatedAt string
    arn String
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt String
    failureReasons List<String>
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    updatedAt String
    arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt string
    failureReasons string[]
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    updatedAt string
    arn str
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    created_at str
    failure_reasons Sequence[str]
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    updated_at str
    arn String
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt String
    failureReasons List<String>
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    updatedAt String

    Look up Existing AgentKnowledgeBase Resource

    Get an existing AgentKnowledgeBase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentKnowledgeBaseState, opts?: CustomResourceOptions): AgentKnowledgeBase
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        failure_reasons: Optional[Sequence[str]] = None,
        knowledge_base_configuration: Optional[AgentKnowledgeBaseKnowledgeBaseConfigurationArgs] = None,
        name: Optional[str] = None,
        role_arn: Optional[str] = None,
        storage_configuration: Optional[AgentKnowledgeBaseStorageConfigurationArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[AgentKnowledgeBaseTimeoutsArgs] = None,
        updated_at: Optional[str] = None) -> AgentKnowledgeBase
    func GetAgentKnowledgeBase(ctx *Context, name string, id IDInput, state *AgentKnowledgeBaseState, opts ...ResourceOption) (*AgentKnowledgeBase, error)
    public static AgentKnowledgeBase Get(string name, Input<string> id, AgentKnowledgeBaseState? state, CustomResourceOptions? opts = null)
    public static AgentKnowledgeBase get(String name, Output<String> id, AgentKnowledgeBaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    CreatedAt string
    Description string
    A description of the knowledge base.
    FailureReasons List<string>
    KnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    Name string
    A name for the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    StorageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Timeouts AgentKnowledgeBaseTimeouts
    UpdatedAt string
    Arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    CreatedAt string
    Description string
    A description of the knowledge base.
    FailureReasons []string
    KnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
    Contains details about the embeddings model used for the knowledge base.
    Name string
    A name for the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    StorageConfiguration AgentKnowledgeBaseStorageConfigurationArgs
    Contains details about the configuration of the vector database used for the knowledge base.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Timeouts AgentKnowledgeBaseTimeoutsArgs
    UpdatedAt string
    arn String
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt String
    description String
    A description of the knowledge base.
    failureReasons List<String>
    knowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    name String
    A name for the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to create the knowledge base.
    storageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    timeouts AgentKnowledgeBaseTimeouts
    updatedAt String
    arn string
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt string
    description string
    A description of the knowledge base.
    failureReasons string[]
    knowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfiguration
    Contains details about the embeddings model used for the knowledge base.
    name string
    A name for the knowledge base.
    roleArn string
    The ARN of the IAM role with permissions to create the knowledge base.
    storageConfiguration AgentKnowledgeBaseStorageConfiguration
    Contains details about the configuration of the vector database used for the knowledge base.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    timeouts AgentKnowledgeBaseTimeouts
    updatedAt string
    arn str
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    created_at str
    description str
    A description of the knowledge base.
    failure_reasons Sequence[str]
    knowledge_base_configuration AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
    Contains details about the embeddings model used for the knowledge base.
    name str
    A name for the knowledge base.
    role_arn str
    The ARN of the IAM role with permissions to create the knowledge base.
    storage_configuration AgentKnowledgeBaseStorageConfigurationArgs
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    timeouts AgentKnowledgeBaseTimeoutsArgs
    updated_at str
    arn String
    ARN of the Knowledge Base. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
    createdAt String
    description String
    A description of the knowledge base.
    failureReasons List<String>
    knowledgeBaseConfiguration Property Map
    Contains details about the embeddings model used for the knowledge base.
    name String
    A name for the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to create the knowledge base.
    storageConfiguration Property Map
    Contains details about the configuration of the vector database used for the knowledge base.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    timeouts Property Map
    updatedAt String

    Supporting Types

    AgentKnowledgeBaseKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationArgs

    Type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    VectorKnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration
    Contains details about the embeddings model that'sused to convert the data source.
    Type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    VectorKnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration
    Contains details about the embeddings model that'sused to convert the data source.
    type String
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    vectorKnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration
    Contains details about the embeddings model that'sused to convert the data source.
    type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    vectorKnowledgeBaseConfiguration AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration
    Contains details about the embeddings model that'sused to convert the data source.
    type str
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    vector_knowledge_base_configuration AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration
    Contains details about the embeddings model that'sused to convert the data source.
    type String
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    vectorKnowledgeBaseConfiguration Property Map
    Contains details about the embeddings model that'sused to convert the data source.

    AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs

    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    embedding_model_arn str
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.

    AgentKnowledgeBaseStorageConfiguration, AgentKnowledgeBaseStorageConfigurationArgs

    Type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    OpensearchServerlessConfiguration AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    PineconeConfiguration AgentKnowledgeBaseStorageConfigurationPineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    RdsConfiguration AgentKnowledgeBaseStorageConfigurationRdsConfiguration
    Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    RedisEnterpriseCloudConfiguration AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    Type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    OpensearchServerlessConfiguration AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    PineconeConfiguration AgentKnowledgeBaseStorageConfigurationPineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    RdsConfiguration AgentKnowledgeBaseStorageConfigurationRdsConfiguration
    Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    RedisEnterpriseCloudConfiguration AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    type String
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    opensearchServerlessConfiguration AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pineconeConfiguration AgentKnowledgeBaseStorageConfigurationPineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rdsConfiguration AgentKnowledgeBaseStorageConfigurationRdsConfiguration
    Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    redisEnterpriseCloudConfiguration AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    type string
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    opensearchServerlessConfiguration AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pineconeConfiguration AgentKnowledgeBaseStorageConfigurationPineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rdsConfiguration AgentKnowledgeBaseStorageConfigurationRdsConfiguration
    Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    redisEnterpriseCloudConfiguration AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    type str
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    opensearch_serverless_configuration AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration
    Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    pinecone_configuration AgentKnowledgeBaseStorageConfigurationPineconeConfiguration
    Contains the storage configuration of the knowledge base in Pinecone.
    rds_configuration AgentKnowledgeBaseStorageConfigurationRdsConfiguration
    Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    redis_enterprise_cloud_configuration AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    type String
    The vector store service in which the knowledge base is stored.Valid Values: OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS
    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.
    redisEnterpriseCloudConfiguration Property Map
    Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

    AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration, AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs

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

    AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs

    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.

    AgentKnowledgeBaseStorageConfigurationPineconeConfiguration, AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs

    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 Redis Enterprise Cloud database.
    FieldMapping AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping
    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 Redis Enterprise Cloud database.
    FieldMapping AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping
    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 Redis Enterprise Cloud database.
    fieldMapping AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping
    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 Redis Enterprise Cloud database.
    fieldMapping AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping
    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 Redis Enterprise Cloud database.
    field_mapping AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping
    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 Redis Enterprise Cloud database.
    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.

    AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs

    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.

    AgentKnowledgeBaseStorageConfigurationRdsConfiguration, AgentKnowledgeBaseStorageConfigurationRdsConfigurationArgs

    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    DatabaseName string
    The name of your Amazon RDS database.
    ResourceArn string
    The namespace to be used to write new data to your database.
    TableName string
    The name of the table in the database.
    FieldMapping AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    DatabaseName string
    The name of your Amazon RDS database.
    ResourceArn string
    The namespace to be used to write new data to your database.
    TableName string
    The name of the table in the database.
    FieldMapping AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    databaseName String
    The name of your Amazon RDS database.
    resourceArn String
    The namespace to be used to write new data to your database.
    tableName String
    The name of the table in the database.
    fieldMapping AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    databaseName string
    The name of your Amazon RDS database.
    resourceArn string
    The namespace to be used to write new data to your database.
    tableName string
    The name of the table in the database.
    fieldMapping AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentials_secret_arn str
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    database_name str
    The name of your Amazon RDS database.
    resource_arn str
    The namespace to be used to write new data to your database.
    table_name str
    The name of the table in the database.
    field_mapping AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    databaseName String
    The name of your Amazon RDS database.
    resourceArn String
    The namespace to be used to write new data to your database.
    tableName String
    The name of the table in the database.
    fieldMapping Property Map
    Contains the names of the fields to which to map information about the vector store.

    AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs

    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.

    AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration, AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs

    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    Endpoint string
    The endpoint URL of the Redis Enterprise Cloud database.
    VectorIndexName string
    The name of the vector store.
    FieldMapping AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    CredentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    Endpoint string
    The endpoint URL of the Redis Enterprise Cloud database.
    VectorIndexName string
    The name of the vector store.
    FieldMapping AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    endpoint String
    The endpoint URL of the Redis Enterprise Cloud database.
    vectorIndexName String
    The name of the vector store.
    fieldMapping AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn string
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    endpoint string
    The endpoint URL of the Redis Enterprise Cloud database.
    vectorIndexName string
    The name of the vector store.
    fieldMapping AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentials_secret_arn str
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    endpoint str
    The endpoint URL of the Redis Enterprise Cloud database.
    vector_index_name str
    The name of the vector store.
    field_mapping AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping
    Contains the names of the fields to which to map information about the vector store.
    credentialsSecretArn String
    The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
    endpoint String
    The endpoint URL of the Redis Enterprise Cloud database.
    vectorIndexName String
    The name of the vector store.
    fieldMapping Property Map
    Contains the names of the fields to which to map information about the vector store.

    AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs

    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.

    AgentKnowledgeBaseTimeouts, AgentKnowledgeBaseTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import Agents for Amazon Bedrock Knowledge Base using the Q1IYMH6GQG. For example:

    $ pulumi import aws:bedrock/agentKnowledgeBase:AgentKnowledgeBase example Q1IYMH6GQG

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi
    pulumi/pulumi-aws