Resource for managing an AWS Agents for Amazon Bedrock Knowledge Base.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentKnowledgeBase("example", {
name: "example",
roleArn: exampleAwsIamRole.arn,
knowledgeBaseConfiguration: {
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
},
type: "VECTOR",
},
storageConfiguration: {
type: "OPENSEARCH_SERVERLESS",
opensearchServerlessConfiguration: {
collectionArn: "arn:aws:aoss:us-west-2:123456789012: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
example = aws.bedrock.AgentKnowledgeBase("example",
name="example",
role_arn=example_aws_iam_role["arn"],
knowledge_base_configuration={
"vector_knowledge_base_configuration": {
"embedding_model_arn": "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
},
"type": "VECTOR",
},
storage_configuration={
"type": "OPENSEARCH_SERVERLESS",
"opensearch_serverless_configuration": {
"collection_arn": "arn:aws:aoss:us-west-2:123456789012:collection/142bezjddq707i5stcrf",
"vector_index_name": "bedrock-knowledge-base-default-index",
"field_mapping": {
"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/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentKnowledgeBase(ctx, "example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
EmbeddingModelArn: pulumi.String("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0"),
},
Type: pulumi.String("VECTOR"),
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
Type: pulumi.String("OPENSEARCH_SERVERLESS"),
OpensearchServerlessConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs{
CollectionArn: pulumi.String("arn:aws:aoss:us-west-2:123456789012: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 example = new Aws.Bedrock.AgentKnowledgeBase("example", new()
{
Name = "example",
RoleArn = exampleAwsIamRole.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-v2:0",
},
Type = "VECTOR",
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
{
Type = "OPENSEARCH_SERVERLESS",
OpensearchServerlessConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs
{
CollectionArn = "arn:aws:aoss:us-west-2:123456789012: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 example = new AgentKnowledgeBase("example", AgentKnowledgeBaseArgs.builder()
.name("example")
.roleArn(exampleAwsIamRole.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
.embeddingModelArn("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0")
.build())
.type("VECTOR")
.build())
.storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
.type("OPENSEARCH_SERVERLESS")
.opensearchServerlessConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs.builder()
.collectionArn("arn:aws:aoss:us-west-2:123456789012: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:
example:
type: aws:bedrock:AgentKnowledgeBase
properties:
name: example
roleArn: ${exampleAwsIamRole.arn}
knowledgeBaseConfiguration:
vectorKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0
type: VECTOR
storageConfiguration:
type: OPENSEARCH_SERVERLESS
opensearchServerlessConfiguration:
collectionArn: arn:aws:aoss:us-west-2:123456789012:collection/142bezjddq707i5stcrf
vectorIndexName: bedrock-knowledge-base-default-index
fieldMapping:
vectorField: bedrock-knowledge-base-default-vector
textField: AMAZON_BEDROCK_TEXT_CHUNK
metadataField: AMAZON_BEDROCK_METADATA
Kendra Knowledge Base
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const kendraExample = new aws.bedrock.AgentKnowledgeBase("kendra_example", {
name: "example-kendra-kb",
roleArn: example.arn,
knowledgeBaseConfiguration: {
type: "KENDRA",
kendraKnowledgeBaseConfiguration: {
kendraIndexArn: "arn:aws:kendra:us-east-1:123456789012:index/example-index-id",
},
},
});
import pulumi
import pulumi_aws as aws
kendra_example = aws.bedrock.AgentKnowledgeBase("kendra_example",
name="example-kendra-kb",
role_arn=example["arn"],
knowledge_base_configuration={
"type": "KENDRA",
"kendra_knowledge_base_configuration": {
"kendra_index_arn": "arn:aws:kendra:us-east-1:123456789012:index/example-index-id",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentKnowledgeBase(ctx, "kendra_example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example-kendra-kb"),
RoleArn: pulumi.Any(example.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
Type: pulumi.String("KENDRA"),
KendraKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs{
KendraIndexArn: pulumi.String("arn:aws:kendra:us-east-1:123456789012:index/example-index-id"),
},
},
})
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 kendraExample = new Aws.Bedrock.AgentKnowledgeBase("kendra_example", new()
{
Name = "example-kendra-kb",
RoleArn = example.Arn,
KnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
{
Type = "KENDRA",
KendraKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs
{
KendraIndexArn = "arn:aws:kendra:us-east-1:123456789012:index/example-index-id",
},
},
});
});
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.AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs;
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 kendraExample = new AgentKnowledgeBase("kendraExample", AgentKnowledgeBaseArgs.builder()
.name("example-kendra-kb")
.roleArn(example.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.type("KENDRA")
.kendraKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs.builder()
.kendraIndexArn("arn:aws:kendra:us-east-1:123456789012:index/example-index-id")
.build())
.build())
.build());
}
}
resources:
kendraExample:
type: aws:bedrock:AgentKnowledgeBase
name: kendra_example
properties:
name: example-kendra-kb
roleArn: ${example.arn}
knowledgeBaseConfiguration:
type: KENDRA
kendraKnowledgeBaseConfiguration:
kendraIndexArn: arn:aws:kendra:us-east-1:123456789012:index/example-index-id
Structured Data Store
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentKnowledgeBase("example", {
name: "example-kb",
roleArn: exampleAwsIamRole.arn,
knowledgeBaseConfiguration: {
type: "SQL",
sqlKnowledgeBaseConfiguration: {
type: "REDSHIFT",
redshiftConfiguration: {
queryEngineConfiguration: {
type: "PROVISIONED",
provisionedConfiguration: {
clusterIdentifier: exampleAwsRedshiftCluster.clusterIdentifier,
authConfiguration: {
type: "USERNAME",
databaseUser: exampleAwsRedshiftCluster.masterUsername,
},
},
},
storageConfiguration: {
type: "REDSHIFT",
redshiftConfiguration: {
databaseName: exampleAwsRedshiftCluster.databaseName,
},
},
},
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentKnowledgeBase("example",
name="example-kb",
role_arn=example_aws_iam_role["arn"],
knowledge_base_configuration={
"type": "SQL",
"sql_knowledge_base_configuration": {
"type": "REDSHIFT",
"redshift_configuration": {
"query_engine_configuration": {
"type": "PROVISIONED",
"provisioned_configuration": {
"cluster_identifier": example_aws_redshift_cluster["clusterIdentifier"],
"auth_configuration": {
"type": "USERNAME",
"database_user": example_aws_redshift_cluster["masterUsername"],
},
},
},
"storage_configuration": {
"type": "REDSHIFT",
"redshift_configuration": {
"database_name": example_aws_redshift_cluster["databaseName"],
},
},
},
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentKnowledgeBase(ctx, "example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example-kb"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
Type: pulumi.String("SQL"),
SqlKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs{
Type: pulumi.String("REDSHIFT"),
RedshiftConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs{
QueryEngineConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs{
Type: pulumi.String("PROVISIONED"),
ProvisionedConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs{
ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.ClusterIdentifier),
AuthConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs{
Type: pulumi.String("USERNAME"),
DatabaseUser: pulumi.Any(exampleAwsRedshiftCluster.MasterUsername),
},
},
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs{
Type: pulumi.String("REDSHIFT"),
RedshiftConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs{
DatabaseName: pulumi.Any(exampleAwsRedshiftCluster.DatabaseName),
},
},
},
},
},
})
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 example = new Aws.Bedrock.AgentKnowledgeBase("example", new()
{
Name = "example-kb",
RoleArn = exampleAwsIamRole.Arn,
KnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
{
Type = "SQL",
SqlKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs
{
Type = "REDSHIFT",
RedshiftConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs
{
QueryEngineConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs
{
Type = "PROVISIONED",
ProvisionedConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs
{
ClusterIdentifier = exampleAwsRedshiftCluster.ClusterIdentifier,
AuthConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs
{
Type = "USERNAME",
DatabaseUser = exampleAwsRedshiftCluster.MasterUsername,
},
},
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs
{
Type = "REDSHIFT",
RedshiftConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs
{
DatabaseName = exampleAwsRedshiftCluster.DatabaseName,
},
},
},
},
},
});
});
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.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs;
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 example = new AgentKnowledgeBase("example", AgentKnowledgeBaseArgs.builder()
.name("example-kb")
.roleArn(exampleAwsIamRole.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.type("SQL")
.sqlKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs.builder()
.type("REDSHIFT")
.redshiftConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs.builder()
.queryEngineConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs.builder()
.type("PROVISIONED")
.provisionedConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs.builder()
.clusterIdentifier(exampleAwsRedshiftCluster.clusterIdentifier())
.authConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs.builder()
.type("USERNAME")
.databaseUser(exampleAwsRedshiftCluster.masterUsername())
.build())
.build())
.build())
.storageConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs.builder()
.type("REDSHIFT")
.redshiftConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs.builder()
.databaseName(exampleAwsRedshiftCluster.databaseName())
.build())
.build())
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:bedrock:AgentKnowledgeBase
properties:
name: example-kb
roleArn: ${exampleAwsIamRole.arn}
knowledgeBaseConfiguration:
type: SQL
sqlKnowledgeBaseConfiguration:
type: REDSHIFT
redshiftConfiguration:
queryEngineConfiguration:
type: PROVISIONED
provisionedConfiguration:
clusterIdentifier: ${exampleAwsRedshiftCluster.clusterIdentifier}
authConfiguration:
type: USERNAME
databaseUser: ${exampleAwsRedshiftCluster.masterUsername}
storageConfiguration:
type: REDSHIFT
redshiftConfiguration:
databaseName: ${exampleAwsRedshiftCluster.databaseName}
OpenSearch Managed Cluster Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentKnowledgeBase("example", {
name: "example",
roleArn: exampleAwsIamRole.arn,
knowledgeBaseConfiguration: {
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
},
type: "VECTOR",
},
storageConfiguration: {
type: "OPENSEARCH_MANAGED_CLUSTER",
opensearchManagedClusterConfiguration: {
domainArn: "arn:aws:es:us-west-2:123456789012:domain/example-domain",
domainEndpoint: "https://search-example-domain.us-west-2.es.amazonaws.com",
vectorIndexName: "example_index",
fieldMapping: {
metadataField: "metadata",
textField: "chunks",
vectorField: "embedding",
},
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentKnowledgeBase("example",
name="example",
role_arn=example_aws_iam_role["arn"],
knowledge_base_configuration={
"vector_knowledge_base_configuration": {
"embedding_model_arn": "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
},
"type": "VECTOR",
},
storage_configuration={
"type": "OPENSEARCH_MANAGED_CLUSTER",
"opensearch_managed_cluster_configuration": {
"domain_arn": "arn:aws:es:us-west-2:123456789012:domain/example-domain",
"domain_endpoint": "https://search-example-domain.us-west-2.es.amazonaws.com",
"vector_index_name": "example_index",
"field_mapping": {
"metadata_field": "metadata",
"text_field": "chunks",
"vector_field": "embedding",
},
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentKnowledgeBase(ctx, "example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
EmbeddingModelArn: pulumi.String("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0"),
},
Type: pulumi.String("VECTOR"),
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
Type: pulumi.String("OPENSEARCH_MANAGED_CLUSTER"),
OpensearchManagedClusterConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs{
DomainArn: pulumi.String("arn:aws:es:us-west-2:123456789012:domain/example-domain"),
DomainEndpoint: pulumi.String("https://search-example-domain.us-west-2.es.amazonaws.com"),
VectorIndexName: pulumi.String("example_index"),
FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs{
MetadataField: pulumi.String("metadata"),
TextField: pulumi.String("chunks"),
VectorField: pulumi.String("embedding"),
},
},
},
})
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 example = new Aws.Bedrock.AgentKnowledgeBase("example", new()
{
Name = "example",
RoleArn = exampleAwsIamRole.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-v2:0",
},
Type = "VECTOR",
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
{
Type = "OPENSEARCH_MANAGED_CLUSTER",
OpensearchManagedClusterConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs
{
DomainArn = "arn:aws:es:us-west-2:123456789012:domain/example-domain",
DomainEndpoint = "https://search-example-domain.us-west-2.es.amazonaws.com",
VectorIndexName = "example_index",
FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs
{
MetadataField = "metadata",
TextField = "chunks",
VectorField = "embedding",
},
},
},
});
});
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.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs;
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 example = new AgentKnowledgeBase("example", AgentKnowledgeBaseArgs.builder()
.name("example")
.roleArn(exampleAwsIamRole.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
.embeddingModelArn("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0")
.build())
.type("VECTOR")
.build())
.storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
.type("OPENSEARCH_MANAGED_CLUSTER")
.opensearchManagedClusterConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs.builder()
.domainArn("arn:aws:es:us-west-2:123456789012:domain/example-domain")
.domainEndpoint("https://search-example-domain.us-west-2.es.amazonaws.com")
.vectorIndexName("example_index")
.fieldMapping(AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs.builder()
.metadataField("metadata")
.textField("chunks")
.vectorField("embedding")
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:bedrock:AgentKnowledgeBase
properties:
name: example
roleArn: ${exampleAwsIamRole.arn}
knowledgeBaseConfiguration:
vectorKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0
type: VECTOR
storageConfiguration:
type: OPENSEARCH_MANAGED_CLUSTER
opensearchManagedClusterConfiguration:
domainArn: arn:aws:es:us-west-2:123456789012:domain/example-domain
domainEndpoint: https://search-example-domain.us-west-2.es.amazonaws.com
vectorIndexName: example_index
fieldMapping:
metadataField: metadata
textField: chunks
vectorField: embedding
With Supplemental Data Storage Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentKnowledgeBase("example", {
name: "example",
roleArn: exampleAwsIamRole.arn,
knowledgeBaseConfiguration: {
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
embeddingModelConfiguration: {
bedrockEmbeddingModelConfiguration: {
dimensions: 1024,
embeddingDataType: "FLOAT32",
},
},
supplementalDataStorageConfiguration: {
storageLocation: {
type: "S3",
s3Location: {
uri: "s3://my-bucket/chunk-processor/",
},
},
},
},
type: "VECTOR",
},
storageConfiguration: {
type: "OPENSEARCH_SERVERLESS",
opensearchServerlessConfiguration: {
collectionArn: "arn:aws:aoss:us-west-2:123456789012: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
example = aws.bedrock.AgentKnowledgeBase("example",
name="example",
role_arn=example_aws_iam_role["arn"],
knowledge_base_configuration={
"vector_knowledge_base_configuration": {
"embedding_model_arn": "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
"embedding_model_configuration": {
"bedrock_embedding_model_configuration": {
"dimensions": 1024,
"embedding_data_type": "FLOAT32",
},
},
"supplemental_data_storage_configuration": {
"storage_location": {
"type": "S3",
"s3Location": {
"uri": "s3://my-bucket/chunk-processor/",
},
},
},
},
"type": "VECTOR",
},
storage_configuration={
"type": "OPENSEARCH_SERVERLESS",
"opensearch_serverless_configuration": {
"collection_arn": "arn:aws:aoss:us-west-2:123456789012:collection/142bezjddq707i5stcrf",
"vector_index_name": "bedrock-knowledge-base-default-index",
"field_mapping": {
"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/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentKnowledgeBase(ctx, "example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
EmbeddingModelArn: pulumi.String("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0"),
EmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs{
BedrockEmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs{
Dimensions: pulumi.Int(1024),
EmbeddingDataType: pulumi.String("FLOAT32"),
},
},
SupplementalDataStorageConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs{
StorageLocation: map[string]interface{}{
"type": "S3",
"s3Location": map[string]interface{}{
"uri": "s3://my-bucket/chunk-processor/",
},
},
},
},
Type: pulumi.String("VECTOR"),
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
Type: pulumi.String("OPENSEARCH_SERVERLESS"),
OpensearchServerlessConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs{
CollectionArn: pulumi.String("arn:aws:aoss:us-west-2:123456789012: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 example = new Aws.Bedrock.AgentKnowledgeBase("example", new()
{
Name = "example",
RoleArn = exampleAwsIamRole.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-v2:0",
EmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs
{
BedrockEmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs
{
Dimensions = 1024,
EmbeddingDataType = "FLOAT32",
},
},
SupplementalDataStorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs
{
StorageLocation =
{
{ "type", "S3" },
{ "s3Location",
{
{ "uri", "s3://my-bucket/chunk-processor/" },
} },
},
},
},
Type = "VECTOR",
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
{
Type = "OPENSEARCH_SERVERLESS",
OpensearchServerlessConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs
{
CollectionArn = "arn:aws:aoss:us-west-2:123456789012: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.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs;
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 example = new AgentKnowledgeBase("example", AgentKnowledgeBaseArgs.builder()
.name("example")
.roleArn(exampleAwsIamRole.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
.embeddingModelArn("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0")
.embeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs.builder()
.bedrockEmbeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs.builder()
.dimensions(1024)
.embeddingDataType("FLOAT32")
.build())
.build())
.supplementalDataStorageConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs.builder()
.storageLocation(Map.ofEntries(
Map.entry("type", "S3"),
Map.entry("s3Location", Map.of("uri", "s3://my-bucket/chunk-processor/"))
))
.build())
.build())
.type("VECTOR")
.build())
.storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
.type("OPENSEARCH_SERVERLESS")
.opensearchServerlessConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs.builder()
.collectionArn("arn:aws:aoss:us-west-2:123456789012: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:
example:
type: aws:bedrock:AgentKnowledgeBase
properties:
name: example
roleArn: ${exampleAwsIamRole.arn}
knowledgeBaseConfiguration:
vectorKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0
embeddingModelConfiguration:
bedrockEmbeddingModelConfiguration:
dimensions: 1024
embeddingDataType: FLOAT32
supplementalDataStorageConfiguration:
storageLocation:
type: S3
s3Location:
uri: s3://my-bucket/chunk-processor/
type: VECTOR
storageConfiguration:
type: OPENSEARCH_SERVERLESS
opensearchServerlessConfiguration:
collectionArn: arn:aws:aoss:us-west-2:123456789012:collection/142bezjddq707i5stcrf
vectorIndexName: bedrock-knowledge-base-default-index
fieldMapping:
vectorField: bedrock-knowledge-base-default-vector
textField: AMAZON_BEDROCK_TEXT_CHUNK
metadataField: AMAZON_BEDROCK_METADATA
S3 Vectors Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.VectorsVectorBucket("example", {vectorBucketName: "example-bucket"});
const exampleVectorsIndex = new aws.s3.VectorsIndex("example", {
indexName: "example-index",
vectorBucketName: example.vectorBucketName,
dataType: "float32",
dimension: 256,
distanceMetric: "euclidean",
});
const exampleAgentKnowledgeBase = new aws.bedrock.AgentKnowledgeBase("example", {
name: "example-s3vectors-kb",
roleArn: exampleAwsIamRole.arn,
knowledgeBaseConfiguration: {
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
embeddingModelConfiguration: {
bedrockEmbeddingModelConfiguration: {
dimensions: 256,
embeddingDataType: "FLOAT32",
},
},
},
type: "VECTOR",
},
storageConfiguration: {
type: "S3_VECTORS",
s3VectorsConfiguration: {
indexArn: exampleVectorsIndex.indexArn,
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.s3.VectorsVectorBucket("example", vector_bucket_name="example-bucket")
example_vectors_index = aws.s3.VectorsIndex("example",
index_name="example-index",
vector_bucket_name=example.vector_bucket_name,
data_type="float32",
dimension=256,
distance_metric="euclidean")
example_agent_knowledge_base = aws.bedrock.AgentKnowledgeBase("example",
name="example-s3vectors-kb",
role_arn=example_aws_iam_role["arn"],
knowledge_base_configuration={
"vector_knowledge_base_configuration": {
"embedding_model_arn": "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0",
"embedding_model_configuration": {
"bedrock_embedding_model_configuration": {
"dimensions": 256,
"embedding_data_type": "FLOAT32",
},
},
},
"type": "VECTOR",
},
storage_configuration={
"type": "S3_VECTORS",
"s3_vectors_configuration": {
"index_arn": example_vectors_index.index_arn,
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := s3.NewVectorsVectorBucket(ctx, "example", &s3.VectorsVectorBucketArgs{
VectorBucketName: pulumi.String("example-bucket"),
})
if err != nil {
return err
}
exampleVectorsIndex, err := s3.NewVectorsIndex(ctx, "example", &s3.VectorsIndexArgs{
IndexName: pulumi.String("example-index"),
VectorBucketName: example.VectorBucketName,
DataType: pulumi.String("float32"),
Dimension: pulumi.Int(256),
DistanceMetric: pulumi.String("euclidean"),
})
if err != nil {
return err
}
_, err = bedrock.NewAgentKnowledgeBase(ctx, "example", &bedrock.AgentKnowledgeBaseArgs{
Name: pulumi.String("example-s3vectors-kb"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationArgs{
VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
EmbeddingModelArn: pulumi.String("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0"),
EmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs{
BedrockEmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs{
Dimensions: pulumi.Int(256),
EmbeddingDataType: pulumi.String("FLOAT32"),
},
},
},
Type: pulumi.String("VECTOR"),
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
Type: pulumi.String("S3_VECTORS"),
S3VectorsConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs{
IndexArn: exampleVectorsIndex.IndexArn,
},
},
})
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 example = new Aws.S3.VectorsVectorBucket("example", new()
{
VectorBucketName = "example-bucket",
});
var exampleVectorsIndex = new Aws.S3.VectorsIndex("example", new()
{
IndexName = "example-index",
VectorBucketName = example.VectorBucketName,
DataType = "float32",
Dimension = 256,
DistanceMetric = "euclidean",
});
var exampleAgentKnowledgeBase = new Aws.Bedrock.AgentKnowledgeBase("example", new()
{
Name = "example-s3vectors-kb",
RoleArn = exampleAwsIamRole.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-v2:0",
EmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs
{
BedrockEmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs
{
Dimensions = 256,
EmbeddingDataType = "FLOAT32",
},
},
},
Type = "VECTOR",
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
{
Type = "S3_VECTORS",
S3VectorsConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs
{
IndexArn = exampleVectorsIndex.IndexArn,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.VectorsVectorBucket;
import com.pulumi.aws.s3.VectorsVectorBucketArgs;
import com.pulumi.aws.s3.VectorsIndex;
import com.pulumi.aws.s3.VectorsIndexArgs;
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.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs;
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 example = new VectorsVectorBucket("example", VectorsVectorBucketArgs.builder()
.vectorBucketName("example-bucket")
.build());
var exampleVectorsIndex = new VectorsIndex("exampleVectorsIndex", VectorsIndexArgs.builder()
.indexName("example-index")
.vectorBucketName(example.vectorBucketName())
.dataType("float32")
.dimension(256)
.distanceMetric("euclidean")
.build());
var exampleAgentKnowledgeBase = new AgentKnowledgeBase("exampleAgentKnowledgeBase", AgentKnowledgeBaseArgs.builder()
.name("example-s3vectors-kb")
.roleArn(exampleAwsIamRole.arn())
.knowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationArgs.builder()
.vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
.embeddingModelArn("arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0")
.embeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs.builder()
.bedrockEmbeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs.builder()
.dimensions(256)
.embeddingDataType("FLOAT32")
.build())
.build())
.build())
.type("VECTOR")
.build())
.storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
.type("S3_VECTORS")
.s3VectorsConfiguration(AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs.builder()
.indexArn(exampleVectorsIndex.indexArn())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:s3:VectorsVectorBucket
properties:
vectorBucketName: example-bucket
exampleVectorsIndex:
type: aws:s3:VectorsIndex
name: example
properties:
indexName: example-index
vectorBucketName: ${example.vectorBucketName}
dataType: float32
dimension: 256
distanceMetric: euclidean
exampleAgentKnowledgeBase:
type: aws:bedrock:AgentKnowledgeBase
name: example
properties:
name: example-s3vectors-kb
roleArn: ${exampleAwsIamRole.arn}
knowledgeBaseConfiguration:
vectorKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0
embeddingModelConfiguration:
bedrockEmbeddingModelConfiguration:
dimensions: 256
embeddingDataType: FLOAT32
type: VECTOR
storageConfiguration:
type: S3_VECTORS
s3VectorsConfiguration:
indexArn: ${exampleVectorsIndex.indexArn}
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,
region: 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.
Constructor 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",
KendraKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs
{
KendraIndexArn = "string",
},
SqlKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs
{
Type = "string",
RedshiftConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs
{
QueryEngineConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs
{
Type = "string",
ProvisionedConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs
{
ClusterIdentifier = "string",
AuthConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs
{
Type = "string",
DatabaseUser = "string",
UsernamePasswordSecretArn = "string",
},
},
ServerlessConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationArgs
{
WorkgroupArn = "string",
AuthConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationAuthConfigurationArgs
{
Type = "string",
UsernamePasswordSecretArn = "string",
},
},
},
QueryGenerationConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationArgs
{
ExecutionTimeoutSeconds = 0,
GenerationContext = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextArgs
{
CuratedQueries = new[]
{
new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQueryArgs
{
NaturalLanguage = "string",
Sql = "string",
},
},
Tables = new[]
{
new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableArgs
{
Name = "string",
Columns = new[]
{
new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumnArgs
{
Description = "string",
Inclusion = "string",
Name = "string",
},
},
Description = "string",
Inclusion = "string",
},
},
},
},
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs
{
Type = "string",
AwsDataCatalogConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationAwsDataCatalogConfigurationArgs
{
TableNames = new[]
{
"string",
},
},
RedshiftConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs
{
DatabaseName = "string",
},
},
},
},
VectorKnowledgeBaseConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs
{
EmbeddingModelArn = "string",
EmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs
{
BedrockEmbeddingModelConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs
{
Dimensions = 0,
EmbeddingDataType = "string",
},
},
SupplementalDataStorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs
{
StorageLocations = new[]
{
new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationArgs
{
Type = "string",
S3Location = new Aws.Bedrock.Inputs.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3LocationArgs
{
Uri = "string",
},
},
},
},
},
},
Name = "string",
Region = "string",
StorageConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationArgs
{
Type = "string",
MongoDbAtlasConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationArgs
{
CollectionName = "string",
CredentialsSecretArn = "string",
DatabaseName = "string",
Endpoint = "string",
VectorIndexName = "string",
EndpointServiceName = "string",
FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationFieldMappingArgs
{
MetadataField = "string",
TextField = "string",
VectorField = "string",
},
TextIndexName = "string",
},
NeptuneAnalyticsConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationArgs
{
GraphArn = "string",
FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationFieldMappingArgs
{
MetadataField = "string",
TextField = "string",
},
},
OpensearchManagedClusterConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs
{
DomainArn = "string",
DomainEndpoint = "string",
VectorIndexName = "string",
FieldMapping = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs
{
MetadataField = "string",
TextField = "string",
VectorField = "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",
CustomMetadataField = "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",
},
},
S3VectorsConfiguration = new Aws.Bedrock.Inputs.AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs
{
IndexArn = "string",
IndexName = "string",
VectorBucketArn = "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"),
KendraKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs{
KendraIndexArn: pulumi.String("string"),
},
SqlKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs{
Type: pulumi.String("string"),
RedshiftConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs{
QueryEngineConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs{
Type: pulumi.String("string"),
ProvisionedConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs{
ClusterIdentifier: pulumi.String("string"),
AuthConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs{
Type: pulumi.String("string"),
DatabaseUser: pulumi.String("string"),
UsernamePasswordSecretArn: pulumi.String("string"),
},
},
ServerlessConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationArgs{
WorkgroupArn: pulumi.String("string"),
AuthConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationAuthConfigurationArgs{
Type: pulumi.String("string"),
UsernamePasswordSecretArn: pulumi.String("string"),
},
},
},
QueryGenerationConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationArgs{
ExecutionTimeoutSeconds: pulumi.Int(0),
GenerationContext: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextArgs{
CuratedQueries: bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQueryArray{
&bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQueryArgs{
NaturalLanguage: pulumi.String("string"),
Sql: pulumi.String("string"),
},
},
Tables: bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableArray{
&bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableArgs{
Name: pulumi.String("string"),
Columns: bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumnArray{
&bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumnArgs{
Description: pulumi.String("string"),
Inclusion: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
Inclusion: pulumi.String("string"),
},
},
},
},
StorageConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs{
Type: pulumi.String("string"),
AwsDataCatalogConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationAwsDataCatalogConfigurationArgs{
TableNames: pulumi.StringArray{
pulumi.String("string"),
},
},
RedshiftConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs{
DatabaseName: pulumi.String("string"),
},
},
},
},
VectorKnowledgeBaseConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs{
EmbeddingModelArn: pulumi.String("string"),
EmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs{
BedrockEmbeddingModelConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs{
Dimensions: pulumi.Int(0),
EmbeddingDataType: pulumi.String("string"),
},
},
SupplementalDataStorageConfiguration: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs{
StorageLocations: bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationArray{
&bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationArgs{
Type: pulumi.String("string"),
S3Location: &bedrock.AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3LocationArgs{
Uri: pulumi.String("string"),
},
},
},
},
},
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
StorageConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationArgs{
Type: pulumi.String("string"),
MongoDbAtlasConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationArgs{
CollectionName: pulumi.String("string"),
CredentialsSecretArn: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
Endpoint: pulumi.String("string"),
VectorIndexName: pulumi.String("string"),
EndpointServiceName: pulumi.String("string"),
FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationFieldMappingArgs{
MetadataField: pulumi.String("string"),
TextField: pulumi.String("string"),
VectorField: pulumi.String("string"),
},
TextIndexName: pulumi.String("string"),
},
NeptuneAnalyticsConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationArgs{
GraphArn: pulumi.String("string"),
FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationFieldMappingArgs{
MetadataField: pulumi.String("string"),
TextField: pulumi.String("string"),
},
},
OpensearchManagedClusterConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs{
DomainArn: pulumi.String("string"),
DomainEndpoint: pulumi.String("string"),
VectorIndexName: pulumi.String("string"),
FieldMapping: &bedrock.AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs{
MetadataField: pulumi.String("string"),
TextField: pulumi.String("string"),
VectorField: 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"),
CustomMetadataField: 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"),
},
},
S3VectorsConfiguration: &bedrock.AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs{
IndexArn: pulumi.String("string"),
IndexName: pulumi.String("string"),
VectorBucketArn: 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")
.kendraKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs.builder()
.kendraIndexArn("string")
.build())
.sqlKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs.builder()
.type("string")
.redshiftConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs.builder()
.queryEngineConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs.builder()
.type("string")
.provisionedConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs.builder()
.clusterIdentifier("string")
.authConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs.builder()
.type("string")
.databaseUser("string")
.usernamePasswordSecretArn("string")
.build())
.build())
.serverlessConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationArgs.builder()
.workgroupArn("string")
.authConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationAuthConfigurationArgs.builder()
.type("string")
.usernamePasswordSecretArn("string")
.build())
.build())
.build())
.queryGenerationConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationArgs.builder()
.executionTimeoutSeconds(0)
.generationContext(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextArgs.builder()
.curatedQueries(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQueryArgs.builder()
.naturalLanguage("string")
.sql("string")
.build())
.tables(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableArgs.builder()
.name("string")
.columns(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumnArgs.builder()
.description("string")
.inclusion("string")
.name("string")
.build())
.description("string")
.inclusion("string")
.build())
.build())
.build())
.storageConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs.builder()
.type("string")
.awsDataCatalogConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationAwsDataCatalogConfigurationArgs.builder()
.tableNames("string")
.build())
.redshiftConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs.builder()
.databaseName("string")
.build())
.build())
.build())
.build())
.vectorKnowledgeBaseConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs.builder()
.embeddingModelArn("string")
.embeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs.builder()
.bedrockEmbeddingModelConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs.builder()
.dimensions(0)
.embeddingDataType("string")
.build())
.build())
.supplementalDataStorageConfiguration(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs.builder()
.storageLocations(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationArgs.builder()
.type("string")
.s3Location(AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3LocationArgs.builder()
.uri("string")
.build())
.build())
.build())
.build())
.build())
.name("string")
.region("string")
.storageConfiguration(AgentKnowledgeBaseStorageConfigurationArgs.builder()
.type("string")
.mongoDbAtlasConfiguration(AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationArgs.builder()
.collectionName("string")
.credentialsSecretArn("string")
.databaseName("string")
.endpoint("string")
.vectorIndexName("string")
.endpointServiceName("string")
.fieldMapping(AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationFieldMappingArgs.builder()
.metadataField("string")
.textField("string")
.vectorField("string")
.build())
.textIndexName("string")
.build())
.neptuneAnalyticsConfiguration(AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationArgs.builder()
.graphArn("string")
.fieldMapping(AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationFieldMappingArgs.builder()
.metadataField("string")
.textField("string")
.build())
.build())
.opensearchManagedClusterConfiguration(AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs.builder()
.domainArn("string")
.domainEndpoint("string")
.vectorIndexName("string")
.fieldMapping(AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs.builder()
.metadataField("string")
.textField("string")
.vectorField("string")
.build())
.build())
.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")
.customMetadataField("string")
.build())
.build())
.redisEnterpriseCloudConfiguration(AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs.builder()
.credentialsSecretArn("string")
.endpoint("string")
.vectorIndexName("string")
.fieldMapping(AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs.builder()
.metadataField("string")
.textField("string")
.vectorField("string")
.build())
.build())
.s3VectorsConfiguration(AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs.builder()
.indexArn("string")
.indexName("string")
.vectorBucketArn("string")
.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={
"type": "string",
"kendra_knowledge_base_configuration": {
"kendra_index_arn": "string",
},
"sql_knowledge_base_configuration": {
"type": "string",
"redshift_configuration": {
"query_engine_configuration": {
"type": "string",
"provisioned_configuration": {
"cluster_identifier": "string",
"auth_configuration": {
"type": "string",
"database_user": "string",
"username_password_secret_arn": "string",
},
},
"serverless_configuration": {
"workgroup_arn": "string",
"auth_configuration": {
"type": "string",
"username_password_secret_arn": "string",
},
},
},
"query_generation_configuration": {
"execution_timeout_seconds": 0,
"generation_context": {
"curated_queries": [{
"natural_language": "string",
"sql": "string",
}],
"tables": [{
"name": "string",
"columns": [{
"description": "string",
"inclusion": "string",
"name": "string",
}],
"description": "string",
"inclusion": "string",
}],
},
},
"storage_configuration": {
"type": "string",
"aws_data_catalog_configuration": {
"table_names": ["string"],
},
"redshift_configuration": {
"database_name": "string",
},
},
},
},
"vector_knowledge_base_configuration": {
"embedding_model_arn": "string",
"embedding_model_configuration": {
"bedrock_embedding_model_configuration": {
"dimensions": 0,
"embedding_data_type": "string",
},
},
"supplemental_data_storage_configuration": {
"storage_locations": [{
"type": "string",
"s3_location": {
"uri": "string",
},
}],
},
},
},
name="string",
region="string",
storage_configuration={
"type": "string",
"mongo_db_atlas_configuration": {
"collection_name": "string",
"credentials_secret_arn": "string",
"database_name": "string",
"endpoint": "string",
"vector_index_name": "string",
"endpoint_service_name": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
"vector_field": "string",
},
"text_index_name": "string",
},
"neptune_analytics_configuration": {
"graph_arn": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
},
},
"opensearch_managed_cluster_configuration": {
"domain_arn": "string",
"domain_endpoint": "string",
"vector_index_name": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
"vector_field": "string",
},
},
"opensearch_serverless_configuration": {
"collection_arn": "string",
"vector_index_name": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
"vector_field": "string",
},
},
"pinecone_configuration": {
"connection_string": "string",
"credentials_secret_arn": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
},
"namespace": "string",
},
"rds_configuration": {
"credentials_secret_arn": "string",
"database_name": "string",
"resource_arn": "string",
"table_name": "string",
"field_mapping": {
"metadata_field": "string",
"primary_key_field": "string",
"text_field": "string",
"vector_field": "string",
"custom_metadata_field": "string",
},
},
"redis_enterprise_cloud_configuration": {
"credentials_secret_arn": "string",
"endpoint": "string",
"vector_index_name": "string",
"field_mapping": {
"metadata_field": "string",
"text_field": "string",
"vector_field": "string",
},
},
"s3_vectors_configuration": {
"index_arn": "string",
"index_name": "string",
"vector_bucket_arn": "string",
},
},
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
"update": "string",
})
const agentKnowledgeBaseResource = new aws.bedrock.AgentKnowledgeBase("agentKnowledgeBaseResource", {
roleArn: "string",
description: "string",
knowledgeBaseConfiguration: {
type: "string",
kendraKnowledgeBaseConfiguration: {
kendraIndexArn: "string",
},
sqlKnowledgeBaseConfiguration: {
type: "string",
redshiftConfiguration: {
queryEngineConfiguration: {
type: "string",
provisionedConfiguration: {
clusterIdentifier: "string",
authConfiguration: {
type: "string",
databaseUser: "string",
usernamePasswordSecretArn: "string",
},
},
serverlessConfiguration: {
workgroupArn: "string",
authConfiguration: {
type: "string",
usernamePasswordSecretArn: "string",
},
},
},
queryGenerationConfiguration: {
executionTimeoutSeconds: 0,
generationContext: {
curatedQueries: [{
naturalLanguage: "string",
sql: "string",
}],
tables: [{
name: "string",
columns: [{
description: "string",
inclusion: "string",
name: "string",
}],
description: "string",
inclusion: "string",
}],
},
},
storageConfiguration: {
type: "string",
awsDataCatalogConfiguration: {
tableNames: ["string"],
},
redshiftConfiguration: {
databaseName: "string",
},
},
},
},
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: "string",
embeddingModelConfiguration: {
bedrockEmbeddingModelConfiguration: {
dimensions: 0,
embeddingDataType: "string",
},
},
supplementalDataStorageConfiguration: {
storageLocations: [{
type: "string",
s3Location: {
uri: "string",
},
}],
},
},
},
name: "string",
region: "string",
storageConfiguration: {
type: "string",
mongoDbAtlasConfiguration: {
collectionName: "string",
credentialsSecretArn: "string",
databaseName: "string",
endpoint: "string",
vectorIndexName: "string",
endpointServiceName: "string",
fieldMapping: {
metadataField: "string",
textField: "string",
vectorField: "string",
},
textIndexName: "string",
},
neptuneAnalyticsConfiguration: {
graphArn: "string",
fieldMapping: {
metadataField: "string",
textField: "string",
},
},
opensearchManagedClusterConfiguration: {
domainArn: "string",
domainEndpoint: "string",
vectorIndexName: "string",
fieldMapping: {
metadataField: "string",
textField: "string",
vectorField: "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",
customMetadataField: "string",
},
},
redisEnterpriseCloudConfiguration: {
credentialsSecretArn: "string",
endpoint: "string",
vectorIndexName: "string",
fieldMapping: {
metadataField: "string",
textField: "string",
vectorField: "string",
},
},
s3VectorsConfiguration: {
indexArn: "string",
indexName: "string",
vectorBucketArn: "string",
},
},
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
});
type: aws:bedrock:AgentKnowledgeBase
properties:
description: string
knowledgeBaseConfiguration:
kendraKnowledgeBaseConfiguration:
kendraIndexArn: string
sqlKnowledgeBaseConfiguration:
redshiftConfiguration:
queryEngineConfiguration:
provisionedConfiguration:
authConfiguration:
databaseUser: string
type: string
usernamePasswordSecretArn: string
clusterIdentifier: string
serverlessConfiguration:
authConfiguration:
type: string
usernamePasswordSecretArn: string
workgroupArn: string
type: string
queryGenerationConfiguration:
executionTimeoutSeconds: 0
generationContext:
curatedQueries:
- naturalLanguage: string
sql: string
tables:
- columns:
- description: string
inclusion: string
name: string
description: string
inclusion: string
name: string
storageConfiguration:
awsDataCatalogConfiguration:
tableNames:
- string
redshiftConfiguration:
databaseName: string
type: string
type: string
type: string
vectorKnowledgeBaseConfiguration:
embeddingModelArn: string
embeddingModelConfiguration:
bedrockEmbeddingModelConfiguration:
dimensions: 0
embeddingDataType: string
supplementalDataStorageConfiguration:
storageLocations:
- s3Location:
uri: string
type: string
name: string
region: string
roleArn: string
storageConfiguration:
mongoDbAtlasConfiguration:
collectionName: string
credentialsSecretArn: string
databaseName: string
endpoint: string
endpointServiceName: string
fieldMapping:
metadataField: string
textField: string
vectorField: string
textIndexName: string
vectorIndexName: string
neptuneAnalyticsConfiguration:
fieldMapping:
metadataField: string
textField: string
graphArn: string
opensearchManagedClusterConfiguration:
domainArn: string
domainEndpoint: string
fieldMapping:
metadataField: string
textField: string
vectorField: string
vectorIndexName: string
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:
customMetadataField: string
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
s3VectorsConfiguration:
indexArn: string
indexName: string
vectorBucketArn: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AgentKnowledgeBase resource accepts the following input properties:
- Role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- Description string
- Description of the knowledge base.
- Knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - Name string
- Name of the knowledge base.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Agent
Knowledge Base Timeouts
- Role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- Description string
- Description of the knowledge base.
- Knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration Args - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - Name string
- Name of the knowledge base.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Storage
Configuration AgentKnowledge Base Storage Configuration Args - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Agent
Knowledge Base Timeouts Args
- role
Arn String ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- description String
- Description of the knowledge base.
- knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name String
- Name of the knowledge base.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Knowledge Base Timeouts
- role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- description string
- Description of the knowledge base.
- knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name string
- Name of the knowledge base.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Knowledge Base Timeouts
- role_
arn str ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- description str
- Description of the knowledge base.
- knowledge_
base_ Agentconfiguration Knowledge Base Knowledge Base Configuration Args - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name str
- Name of the knowledge base.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- storage_
configuration AgentKnowledge Base Storage Configuration Args - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Agent
Knowledge Base Timeouts Args
- role
Arn String ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- description String
- Description of the knowledge base.
- knowledge
Base Property MapConfiguration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name String
- Name of the knowledge base.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- storage
Configuration Property Map - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration 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.
- Created
At string - Time at which the knowledge base was created.
- Failure
Reasons List<string> - Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - Time at which the knowledge base was last updated.
- Arn string
- ARN of the knowledge base.
- Created
At string - Time at which the knowledge base was created.
- Failure
Reasons []string - Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - Time at which the knowledge base was last updated.
- arn String
- ARN of the knowledge base.
- created
At String - Time at which the knowledge base was created.
- failure
Reasons List<String> - id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - Time at which the knowledge base was last updated.
- arn string
- ARN of the knowledge base.
- created
At string - Time at which the knowledge base was created.
- failure
Reasons string[] - id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At string - Time at which the knowledge base was last updated.
- arn str
- ARN of the knowledge base.
- created_
at str - Time at which the knowledge base was created.
- failure_
reasons Sequence[str] - id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated_
at str - Time at which the knowledge base was last updated.
- arn String
- ARN of the knowledge base.
- created
At String - Time at which the knowledge base was created.
- failure
Reasons List<String> - id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - Time at which the knowledge base was last updated.
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,
region: 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) -> AgentKnowledgeBasefunc 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)resources: _: type: aws:bedrock:AgentKnowledgeBase get: id: ${id}- 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.
- Arn string
- ARN of the knowledge base.
- Created
At string - Time at which the knowledge base was created.
- Description string
- Description of the knowledge base.
- Failure
Reasons List<string> - Knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - Name string
- Name of the knowledge base.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- Storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Agent
Knowledge Base Timeouts - Updated
At string - Time at which the knowledge base was last updated.
- Arn string
- ARN of the knowledge base.
- Created
At string - Time at which the knowledge base was created.
- Description string
- Description of the knowledge base.
- Failure
Reasons []string - Knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration Args - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - Name string
- Name of the knowledge base.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- Storage
Configuration AgentKnowledge Base Storage Configuration Args - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Agent
Knowledge Base Timeouts Args - Updated
At string - Time at which the knowledge base was last updated.
- arn String
- ARN of the knowledge base.
- created
At String - Time at which the knowledge base was created.
- description String
- Description of the knowledge base.
- failure
Reasons List<String> - knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name String
- Name of the knowledge base.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn String ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Agent
Knowledge Base Timeouts - updated
At String - Time at which the knowledge base was last updated.
- arn string
- ARN of the knowledge base.
- created
At string - Time at which the knowledge base was created.
- description string
- Description of the knowledge base.
- failure
Reasons string[] - knowledge
Base AgentConfiguration Knowledge Base Knowledge Base Configuration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name string
- Name of the knowledge base.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn string ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- storage
Configuration AgentKnowledge Base Storage Configuration - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Agent
Knowledge Base Timeouts - updated
At string - Time at which the knowledge base was last updated.
- arn str
- ARN of the knowledge base.
- created_
at str - Time at which the knowledge base was created.
- description str
- Description of the knowledge base.
- failure_
reasons Sequence[str] - knowledge_
base_ Agentconfiguration Knowledge Base Knowledge Base Configuration Args - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name str
- Name of the knowledge base.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role_
arn str ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- storage_
configuration AgentKnowledge Base Storage Configuration Args - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Agent
Knowledge Base Timeouts Args - updated_
at str - Time at which the knowledge base was last updated.
- arn String
- ARN of the knowledge base.
- created
At String - Time at which the knowledge base was created.
- description String
- Description of the knowledge base.
- failure
Reasons List<String> - knowledge
Base Property MapConfiguration - Details about the embeddings configuration of the knowledge base. See
knowledge_base_configurationblock for details. - name String
- Name of the knowledge base.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn String ARN of the IAM role with permissions to invoke API operations on the knowledge base.
The following arguments are optional:
- storage
Configuration Property Map - Details about the storage configuration of the knowledge base. See
storage_configurationblock for details. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts Property Map
- updated
At String - Time at which the knowledge base was last updated.
Supporting Types
AgentKnowledgeBaseKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationArgs
- Type string
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - Kendra
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - Sql
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - Vector
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
- Type string
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - Kendra
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - Sql
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - Vector
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
- type String
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - kendra
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - sql
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - vector
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
- type string
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - kendra
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - sql
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - vector
Knowledge AgentBase Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
- type str
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - kendra_
knowledge_ Agentbase_ configuration Knowledge Base Knowledge Base Configuration Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - sql_
knowledge_ Agentbase_ configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - vector_
knowledge_ Agentbase_ configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
- type String
- Type of data that the data source is converted into for the knowledge base. Valid Values:
VECTOR,KENDRA,SQL. - kendra
Knowledge Property MapBase Configuration - Settings for an Amazon Kendra knowledge base. See
kendra_knowledge_base_configurationblock for details. - sql
Knowledge Property MapBase Configuration - Configurations for a knowledge base connected to an SQL database. See
sql_knowledge_base_configurationblock for details. - vector
Knowledge Property MapBase Configuration - Details about the model that's used to convert the data source into vector embeddings. See
vector_knowledge_base_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationKendraKnowledgeBaseConfigurationArgs
- Kendra
Index stringArn - ARN of the Amazon Kendra index.
- Kendra
Index stringArn - ARN of the Amazon Kendra index.
- kendra
Index StringArn - ARN of the Amazon Kendra index.
- kendra
Index stringArn - ARN of the Amazon Kendra index.
- kendra_
index_ strarn - ARN of the Amazon Kendra index.
- kendra
Index StringArn - ARN of the Amazon Kendra index.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationArgs
- Type string
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - Redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
- Type string
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - Redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
- type String
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
- type string
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
- type str
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - redshift_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
- type String
- Type of SQL database to connect to the knowledge base. Valid values:
REDSHIFT. - redshift
Configuration Property Map - Configurations for a knowledge base connected to an Amazon Redshift database. See
redshift_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationArgs
- Query
Engine AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - Query
Generation AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration - Configurations for generating queries. See
query_generation_configurationblock for details. - Storage
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
- Query
Engine AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - Query
Generation AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration - Configurations for generating queries. See
query_generation_configurationblock for details. - Storage
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
- query
Engine AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - query
Generation AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration - Configurations for generating queries. See
query_generation_configurationblock for details. - storage
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
- query
Engine AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - query
Generation AgentConfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration - Configurations for generating queries. See
query_generation_configurationblock for details. - storage
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
- query_
engine_ Agentconfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - query_
generation_ Agentconfiguration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration - Configurations for generating queries. See
query_generation_configurationblock for details. - storage_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
- query
Engine Property MapConfiguration - Configurations for an Amazon Redshift query engine. See
query_engine_configurationblock for details. - query
Generation Property MapConfiguration - Configurations for generating queries. See
query_generation_configurationblock for details. - storage
Configuration Property Map - Configurations for Amazon Redshift database storage. See
storage_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationArgs
- Type string
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - Provisioned
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - Serverless
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
- Type string
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - Provisioned
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - Serverless
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
- type String
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - provisioned
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - serverless
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
- type string
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - provisioned
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - serverless
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
- type str
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - provisioned_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - serverless_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
- type String
- Type of query engine. Valid values:
SERVERLESS,PROVISIONED. - provisioned
Configuration Property Map - Configurations for a provisioned Amazon Redshift query engine. See
provisioned_configurationblock for details. - serverless
Configuration Property Map - Configurations for a serverless Amazon Redshift query engine. See
serverless_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationArgs
- Cluster
Identifier string - ID of the Amazon Redshift cluster.
- Auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration Auth Configuration - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
- Cluster
Identifier string - ID of the Amazon Redshift cluster.
- Auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration Auth Configuration - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
- cluster
Identifier String - ID of the Amazon Redshift cluster.
- auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration Auth Configuration - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
- cluster
Identifier string - ID of the Amazon Redshift cluster.
- auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration Auth Configuration - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
- cluster_
identifier str - ID of the Amazon Redshift cluster.
- auth_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Provisioned Configuration Auth Configuration - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
- cluster
Identifier String - ID of the Amazon Redshift cluster.
- auth
Configuration Property Map - Configurations for authentication to Amazon Redshift. See
auth_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationProvisionedConfigurationAuthConfigurationArgs
- Type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - Database
User string - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- Username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- Type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - Database
User string - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- Username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type String
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - database
User String - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- username
Password StringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - database
User string - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type str
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - database_
user str - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- username_
password_ strsecret_ arn - ARN of a Secrets Manager secret for authentication.
- type String
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - database
User String - Database username for authentication to an Amazon Redshift provisioned data warehouse.
- username
Password StringSecret Arn - ARN of a Secrets Manager secret for authentication.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationArgs
- Workgroup
Arn string - ARN of the Amazon Redshift workgroup.
- Auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration Auth Configuration - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
- Workgroup
Arn string - ARN of the Amazon Redshift workgroup.
- Auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration Auth Configuration - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
- workgroup
Arn String - ARN of the Amazon Redshift workgroup.
- auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration Auth Configuration - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
- workgroup
Arn string - ARN of the Amazon Redshift workgroup.
- auth
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration Auth Configuration - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
- workgroup_
arn str - ARN of the Amazon Redshift workgroup.
- auth_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Engine Configuration Serverless Configuration Auth Configuration - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
- workgroup
Arn String - ARN of the Amazon Redshift workgroup.
- auth
Configuration Property Map - Configurations for authentication to a Redshift Serverless. See
auth_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationAuthConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryEngineConfigurationServerlessConfigurationAuthConfigurationArgs
- Type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - Username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- Type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - Username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type String
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - username
Password StringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type string
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - username
Password stringSecret Arn - ARN of a Secrets Manager secret for authentication.
- type str
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - username_
password_ strsecret_ arn - ARN of a Secrets Manager secret for authentication.
- type String
- Type of authentication to use. Valid values:
IAM,USERNAME_PASSWORD. - username
Password StringSecret Arn - ARN of a Secrets Manager secret for authentication.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationArgs
- Execution
Timeout intSeconds - Time after which query generation will time out.
- Generation
Context AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context - Configurations for context to use during query generation. See
generation_contextblock for details.
- Execution
Timeout intSeconds - Time after which query generation will time out.
- Generation
Context AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context - Configurations for context to use during query generation. See
generation_contextblock for details.
- execution
Timeout IntegerSeconds - Time after which query generation will time out.
- generation
Context AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context - Configurations for context to use during query generation. See
generation_contextblock for details.
- execution
Timeout numberSeconds - Time after which query generation will time out.
- generation
Context AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context - Configurations for context to use during query generation. See
generation_contextblock for details.
- execution_
timeout_ intseconds - Time after which query generation will time out.
- generation_
context AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context - Configurations for context to use during query generation. See
generation_contextblock for details.
- execution
Timeout NumberSeconds - Time after which query generation will time out.
- generation
Context Property Map - Configurations for context to use during query generation. See
generation_contextblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContext, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextArgs
- Curated
Queries List<AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Curated Query> - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - Tables
List<Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table> - Information about a table in the database. See
tableblock for details.
- Curated
Queries []AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Curated Query - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - Tables
[]Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table - Information about a table in the database. See
tableblock for details.
- curated
Queries List<AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Curated Query> - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - tables
List<Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table> - Information about a table in the database. See
tableblock for details.
- curated
Queries AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Curated Query[] - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - tables
Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table[] - Information about a table in the database. See
tableblock for details.
- curated_
queries Sequence[AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Curated Query] - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - tables
Sequence[Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table] - Information about a table in the database. See
tableblock for details.
- curated
Queries List<Property Map> - Information about example queries to help the query engine generate appropriate SQL queries. See
curated_queryblock for details. - tables List<Property Map>
- Information about a table in the database. See
tableblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQuery, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextCuratedQueryArgs
- Natural
Language string - Example natural language query.
- Sql string
- SQL equivalent of
natural_language.
- Natural
Language string - Example natural language query.
- Sql string
- SQL equivalent of
natural_language.
- natural
Language String - Example natural language query.
- sql String
- SQL equivalent of
natural_language.
- natural
Language string - Example natural language query.
- sql string
- SQL equivalent of
natural_language.
- natural_
language str - Example natural language query.
- sql str
- SQL equivalent of
natural_language.
- natural
Language String - Example natural language query.
- sql String
- SQL equivalent of
natural_language.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTable, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableArgs
- Name string
- Name of the table for which the other fields in this object apply.
- Columns
List<Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table Column> - Information about a column in the table. See
columnblock for details. - Description string
- Description of the table that helps the query engine understand the contents of the table.
- Inclusion string
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
- Name string
- Name of the table for which the other fields in this object apply.
- Columns
[]Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table Column - Information about a column in the table. See
columnblock for details. - Description string
- Description of the table that helps the query engine understand the contents of the table.
- Inclusion string
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
- name String
- Name of the table for which the other fields in this object apply.
- columns
List<Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table Column> - Information about a column in the table. See
columnblock for details. - description String
- Description of the table that helps the query engine understand the contents of the table.
- inclusion String
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
- name string
- Name of the table for which the other fields in this object apply.
- columns
Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table Column[] - Information about a column in the table. See
columnblock for details. - description string
- Description of the table that helps the query engine understand the contents of the table.
- inclusion string
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
- name str
- Name of the table for which the other fields in this object apply.
- columns
Sequence[Agent
Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Query Generation Configuration Generation Context Table Column] - Information about a column in the table. See
columnblock for details. - description str
- Description of the table that helps the query engine understand the contents of the table.
- inclusion str
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
- name String
- Name of the table for which the other fields in this object apply.
- columns List<Property Map>
- Information about a column in the table. See
columnblock for details. - description String
- Description of the table that helps the query engine understand the contents of the table.
- inclusion String
- Whether to include or exclude the table during query generation. Valid values
INCLUDE,EXCLUDE.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumn, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationQueryGenerationConfigurationGenerationContextTableColumnArgs
- Description string
- Description of the column that helps the query engine understand the contents of the column.
- Inclusion string
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - Name string
- Name of the column for which the other fields in this object apply.
- Description string
- Description of the column that helps the query engine understand the contents of the column.
- Inclusion string
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - Name string
- Name of the column for which the other fields in this object apply.
- description String
- Description of the column that helps the query engine understand the contents of the column.
- inclusion String
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - name String
- Name of the column for which the other fields in this object apply.
- description string
- Description of the column that helps the query engine understand the contents of the column.
- inclusion string
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - name string
- Name of the column for which the other fields in this object apply.
- description str
- Description of the column that helps the query engine understand the contents of the column.
- inclusion str
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - name str
- Name of the column for which the other fields in this object apply.
- description String
- Description of the column that helps the query engine understand the contents of the column.
- inclusion String
- Whether to include or exclude the column during query generation. Valid values
INCLUDE,EXCLUDE. - name String
- Name of the column for which the other fields in this object apply.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationArgs
- Type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - Aws
Data AgentCatalog Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Aws Data Catalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - Redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Redshift Configuration - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
- Type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - Aws
Data AgentCatalog Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Aws Data Catalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - Redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Redshift Configuration - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
- type String
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - aws
Data AgentCatalog Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Aws Data Catalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Redshift Configuration - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
- type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - aws
Data AgentCatalog Configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Aws Data Catalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - redshift
Configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Redshift Configuration - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
- type str
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - aws_
data_ Agentcatalog_ configuration Knowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Aws Data Catalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - redshift_
configuration AgentKnowledge Base Knowledge Base Configuration Sql Knowledge Base Configuration Redshift Configuration Storage Configuration Redshift Configuration - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
- type String
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - aws
Data Property MapCatalog Configuration - Configurations for storage in AWS Glue Data Catalog. See
aws_data_catalog_configurationblock for details. - redshift
Configuration Property Map - Configurations for storage in Amazon Redshift. See
redshift_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationAwsDataCatalogConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationAwsDataCatalogConfigurationArgs
- Table
Names List<string> - List of names of the tables to use.
- Table
Names []string - List of names of the tables to use.
- table
Names List<String> - List of names of the tables to use.
- table
Names string[] - List of names of the tables to use.
- table_
names Sequence[str] - List of names of the tables to use.
- table
Names List<String> - List of names of the tables to use.
AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationSqlKnowledgeBaseConfigurationRedshiftConfigurationStorageConfigurationRedshiftConfigurationArgs
- Database
Name string - Name of the Amazon Redshift database.
- Database
Name string - Name of the Amazon Redshift database.
- database
Name String - Name of the Amazon Redshift database.
- database
Name string - Name of the Amazon Redshift database.
- database_
name str - Name of the Amazon Redshift database.
- database
Name String - Name of the Amazon Redshift database.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationArgs
- Embedding
Model stringArn - ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model AgentConfiguration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - Supplemental
Data AgentStorage Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
- Embedding
Model stringArn - ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model AgentConfiguration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - Supplemental
Data AgentStorage Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
- embedding
Model StringArn - ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model AgentConfiguration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - supplemental
Data AgentStorage Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
- embedding
Model stringArn - ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model AgentConfiguration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - supplemental
Data AgentStorage Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
- embedding_
model_ strarn - ARN of the model used to create vector embeddings for the knowledge base.
- embedding_
model_ Agentconfiguration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - supplemental_
data_ Agentstorage_ configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
- embedding
Model StringArn - ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model Property MapConfiguration - The embeddings model configuration details for the vector model used in Knowledge Base. See
embedding_model_configurationblock for details. - supplemental
Data Property MapStorage Configuration - supplemental_data_storage_configuration. See
supplemental_data_storage_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationArgs
- Bedrock
Embedding AgentModel Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
- Bedrock
Embedding AgentModel Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
- bedrock
Embedding AgentModel Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
- bedrock
Embedding AgentModel Configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
- bedrock_
embedding_ Agentmodel_ configuration Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Embedding Model Configuration Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
- bedrock
Embedding Property MapModel Configuration - The vector configuration details on the Bedrock embeddings model. See
bedrock_embedding_model_configurationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfigurationArgs
- Dimensions int
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- Embedding
Data stringType - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
- Dimensions int
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- Embedding
Data stringType - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
- dimensions Integer
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- embedding
Data StringType - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
- dimensions number
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- embedding
Data stringType - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
- dimensions int
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- embedding_
data_ strtype - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
- dimensions Number
- Dimension details for the vector configuration used on the Bedrock embeddings model.
- embedding
Data StringType - Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are
FLOAT32andBINARY.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationArgs
- Storage
Locations List<AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location> - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
- Storage
Locations []AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
- storage
Locations List<AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location> - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
- storage
Locations AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location[] - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
- storage_
locations Sequence[AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location] - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
- storage
Locations List<Property Map> - A storage location specification for images extracted from multimodal documents in your data source. See
storage_locationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationArgs
- Type string
- Storage service used for this location.
S3is the only valid value. - S3Location
Agent
Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location S3Location - Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
- Type string
- Storage service used for this location.
S3is the only valid value. - S3Location
Agent
Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location S3Location - Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
- type String
- Storage service used for this location.
S3is the only valid value. - s3Location
Agent
Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location S3Location - Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
- type string
- Storage service used for this location.
S3is the only valid value. - s3Location
Agent
Knowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location S3Location - Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
- type str
- Storage service used for this location.
S3is the only valid value. - s3_
location AgentKnowledge Base Knowledge Base Configuration Vector Knowledge Base Configuration Supplemental Data Storage Configuration Storage Location S3Location - Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
- type String
- Storage service used for this location.
S3is the only valid value. - s3Location Property Map
- Contains information about the Amazon S3 location for the extracted images. See
s3_locationblock for details.
AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location, AgentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3LocationArgs
- Uri string
- URI of the location.
- Uri string
- URI of the location.
- uri String
- URI of the location.
- uri string
- URI of the location.
- uri str
- URI of the location.
- uri String
- URI of the location.
AgentKnowledgeBaseStorageConfiguration, AgentKnowledgeBaseStorageConfigurationArgs
- Type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - Mongo
Db AgentAtlas Configuration Knowledge Base Storage Configuration Mongo Db Atlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - Neptune
Analytics AgentConfiguration Knowledge Base Storage Configuration Neptune Analytics Configuration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - Opensearch
Managed AgentCluster Configuration Knowledge Base Storage Configuration Opensearch Managed Cluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - Opensearch
Serverless AgentConfiguration Knowledge Base Storage Configuration Opensearch Serverless Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - Pinecone
Configuration AgentKnowledge Base Storage Configuration Pinecone Configuration - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - Rds
Configuration AgentKnowledge Base Storage Configuration Rds Configuration - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - Redis
Enterprise AgentCloud Configuration Knowledge Base Storage Configuration Redis Enterprise Cloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - S3Vectors
Configuration AgentKnowledge Base Storage Configuration S3Vectors Configuration - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
- Type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - Mongo
Db AgentAtlas Configuration Knowledge Base Storage Configuration Mongo Db Atlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - Neptune
Analytics AgentConfiguration Knowledge Base Storage Configuration Neptune Analytics Configuration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - Opensearch
Managed AgentCluster Configuration Knowledge Base Storage Configuration Opensearch Managed Cluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - Opensearch
Serverless AgentConfiguration Knowledge Base Storage Configuration Opensearch Serverless Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - Pinecone
Configuration AgentKnowledge Base Storage Configuration Pinecone Configuration - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - Rds
Configuration AgentKnowledge Base Storage Configuration Rds Configuration - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - Redis
Enterprise AgentCloud Configuration Knowledge Base Storage Configuration Redis Enterprise Cloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - S3Vectors
Configuration AgentKnowledge Base Storage Configuration S3Vectors Configuration - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
- type String
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - mongo
Db AgentAtlas Configuration Knowledge Base Storage Configuration Mongo Db Atlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - neptune
Analytics AgentConfiguration Knowledge Base Storage Configuration Neptune Analytics Configuration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - opensearch
Managed AgentCluster Configuration Knowledge Base Storage Configuration Opensearch Managed Cluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - opensearch
Serverless AgentConfiguration Knowledge Base Storage Configuration Opensearch Serverless Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - pinecone
Configuration AgentKnowledge Base Storage Configuration Pinecone Configuration - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - rds
Configuration AgentKnowledge Base Storage Configuration Rds Configuration - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - redis
Enterprise AgentCloud Configuration Knowledge Base Storage Configuration Redis Enterprise Cloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - s3Vectors
Configuration AgentKnowledge Base Storage Configuration S3Vectors Configuration - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
- type string
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - mongo
Db AgentAtlas Configuration Knowledge Base Storage Configuration Mongo Db Atlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - neptune
Analytics AgentConfiguration Knowledge Base Storage Configuration Neptune Analytics Configuration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - opensearch
Managed AgentCluster Configuration Knowledge Base Storage Configuration Opensearch Managed Cluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - opensearch
Serverless AgentConfiguration Knowledge Base Storage Configuration Opensearch Serverless Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - pinecone
Configuration AgentKnowledge Base Storage Configuration Pinecone Configuration - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - rds
Configuration AgentKnowledge Base Storage Configuration Rds Configuration - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - redis
Enterprise AgentCloud Configuration Knowledge Base Storage Configuration Redis Enterprise Cloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - s3Vectors
Configuration AgentKnowledge Base Storage Configuration S3Vectors Configuration - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
- type str
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - mongo_
db_ Agentatlas_ configuration Knowledge Base Storage Configuration Mongo Db Atlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - neptune_
analytics_ Agentconfiguration Knowledge Base Storage Configuration Neptune Analytics Configuration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - opensearch_
managed_ Agentcluster_ configuration Knowledge Base Storage Configuration Opensearch Managed Cluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - opensearch_
serverless_ Agentconfiguration Knowledge Base Storage Configuration Opensearch Serverless Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - pinecone_
configuration AgentKnowledge Base Storage Configuration Pinecone Configuration - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - rds_
configuration AgentKnowledge Base Storage Configuration Rds Configuration - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - redis_
enterprise_ Agentcloud_ configuration Knowledge Base Storage Configuration Redis Enterprise Cloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - s3_
vectors_ Agentconfiguration Knowledge Base Storage Configuration S3Vectors Configuration - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
- type String
- Vector store service in which the knowledge base is stored. Valid Values:
MONGO_DB_ATLAS,OPENSEARCH_SERVERLESS,OPENSEARCH_MANAGED_CLUSTER,PINECONE,REDIS_ENTERPRISE_CLOUD,RDS,S3_VECTORS,NEPTUNE_ANALYTICS. - mongo
Db Property MapAtlas Configuration - The storage configuration of the knowledge base in MongoDB Atlas. See
mongo_db_atlas_configurationblock for details. - neptune
Analytics Property MapConfiguration - The storage configuration of the knowledge base in Amazon Neptune Analytics. See
neptune_analytics_configurationblock for details. - opensearch
Managed Property MapCluster Configuration - The storage configuration of the knowledge base in Amazon OpenSearch Service Managed Cluster. See
opensearch_managed_cluster_configurationblock for details. - opensearch
Serverless Property MapConfiguration - The storage configuration of the knowledge base in Amazon OpenSearch Service Serverless. See
opensearch_serverless_configurationblock for details. - pinecone
Configuration Property Map - The storage configuration of the knowledge base in Pinecone. See
pinecone_configurationblock for details. - rds
Configuration Property Map - Details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. See
rds_configurationblock for details. - redis
Enterprise Property MapCloud Configuration - The storage configuration of the knowledge base in Redis Enterprise Cloud. See
redis_enterprise_cloud_configurationblock for details. - s3Vectors
Configuration Property Map - The storage configuration of the knowledge base in Amazon S3 Vectors. See
s3_vectors_configurationblock for details.
AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfiguration, AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationArgs
- Collection
Name string - The name of the collection in the MongoDB Atlas database.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- Database
Name string - The name of the database in the MongoDB Atlas database.
- Endpoint string
- The endpoint URL of the MongoDB Atlas database.
- Vector
Index stringName - The name of the vector index.
- Endpoint
Service stringName - The name of the service that hosts the MongoDB Atlas database.
- Field
Mapping AgentKnowledge Base Storage Configuration Mongo Db Atlas Configuration Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Text
Index stringName - The name of the vector index.
- Collection
Name string - The name of the collection in the MongoDB Atlas database.
- Credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- Database
Name string - The name of the database in the MongoDB Atlas database.
- Endpoint string
- The endpoint URL of the MongoDB Atlas database.
- Vector
Index stringName - The name of the vector index.
- Endpoint
Service stringName - The name of the service that hosts the MongoDB Atlas database.
- Field
Mapping AgentKnowledge Base Storage Configuration Mongo Db Atlas Configuration Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Text
Index stringName - The name of the vector index.
- collection
Name String - The name of the collection in the MongoDB Atlas database.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- database
Name String - The name of the database in the MongoDB Atlas database.
- endpoint String
- The endpoint URL of the MongoDB Atlas database.
- vector
Index StringName - The name of the vector index.
- endpoint
Service StringName - The name of the service that hosts the MongoDB Atlas database.
- field
Mapping AgentKnowledge Base Storage Configuration Mongo Db Atlas Configuration Field Mapping - Contains the names of the fields to which to map information about the vector store.
- text
Index StringName - The name of the vector index.
- collection
Name string - The name of the collection in the MongoDB Atlas database.
- credentials
Secret stringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- database
Name string - The name of the database in the MongoDB Atlas database.
- endpoint string
- The endpoint URL of the MongoDB Atlas database.
- vector
Index stringName - The name of the vector index.
- endpoint
Service stringName - The name of the service that hosts the MongoDB Atlas database.
- field
Mapping AgentKnowledge Base Storage Configuration Mongo Db Atlas Configuration Field Mapping - Contains the names of the fields to which to map information about the vector store.
- text
Index stringName - The name of the vector index.
- collection_
name str - The name of the collection in the MongoDB Atlas database.
- credentials_
secret_ strarn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- database_
name str - The name of the database in the MongoDB Atlas database.
- endpoint str
- The endpoint URL of the MongoDB Atlas database.
- vector_
index_ strname - The name of the vector index.
- endpoint_
service_ strname - The name of the service that hosts the MongoDB Atlas database.
- field_
mapping AgentKnowledge Base Storage Configuration Mongo Db Atlas Configuration Field Mapping - Contains the names of the fields to which to map information about the vector store.
- text_
index_ strname - The name of the vector index.
- collection
Name String - The name of the collection in the MongoDB Atlas database.
- credentials
Secret StringArn - The ARN of the secret that you created in AWS Secrets Manager that is linked to your MongoDB Atlas database.
- database
Name String - The name of the database in the MongoDB Atlas database.
- endpoint String
- The endpoint URL of the MongoDB Atlas database.
- vector
Index StringName - The name of the vector index.
- endpoint
Service StringName - The name of the service that hosts the MongoDB Atlas database.
- field
Mapping Property Map - Contains the names of the fields to which to map information about the vector store.
- text
Index StringName - The name of the vector index.
AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationMongoDbAtlasConfigurationFieldMappingArgs
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector_
field str - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfiguration, AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationArgs
- Graph
Arn string - ARN of the Neptune Analytics vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Neptune Analytics Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Graph
Arn string - ARN of the Neptune Analytics vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Neptune Analytics Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- graph
Arn String - ARN of the Neptune Analytics vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Neptune Analytics Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- graph
Arn string - ARN of the Neptune Analytics vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Neptune Analytics Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- graph_
arn str - ARN of the Neptune Analytics vector store.
- field_
mapping AgentKnowledge Base Storage Configuration Neptune Analytics Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- graph
Arn String - ARN of the Neptune Analytics vector store.
- field
Mapping Property Map - The names of the fields to which to map information about the vector store. This block supports the following arguments:
AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationNeptuneAnalyticsConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - 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 - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - 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.
AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfiguration, AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationArgs
- Domain
Arn string - ARN of the OpenSearch domain.
- Domain
Endpoint string - Endpoint URL of the OpenSearch domain.
- Vector
Index stringName - Name of the vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Opensearch Managed Cluster Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Domain
Arn string - ARN of the OpenSearch domain.
- Domain
Endpoint string - Endpoint URL of the OpenSearch domain.
- Vector
Index stringName - Name of the vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Opensearch Managed Cluster Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- domain
Arn String - ARN of the OpenSearch domain.
- domain
Endpoint String - Endpoint URL of the OpenSearch domain.
- vector
Index StringName - Name of the vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Opensearch Managed Cluster Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- domain
Arn string - ARN of the OpenSearch domain.
- domain
Endpoint string - Endpoint URL of the OpenSearch domain.
- vector
Index stringName - Name of the vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Opensearch Managed Cluster Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- domain_
arn str - ARN of the OpenSearch domain.
- domain_
endpoint str - Endpoint URL of the OpenSearch domain.
- vector_
index_ strname - Name of the vector store.
- field_
mapping AgentKnowledge Base Storage Configuration Opensearch Managed Cluster Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- domain
Arn String - ARN of the OpenSearch domain.
- domain
Endpoint String - Endpoint URL of the OpenSearch domain.
- vector
Index StringName - Name of the vector store.
- field
Mapping Property Map - The names of the fields to which to map information about the vector store. This block supports the following arguments:
AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationOpensearchManagedClusterConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - 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 - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfiguration, AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationArgs
- Collection
Arn string - ARN of the OpenSearch Service vector store.
- Vector
Index stringName - Name of the vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Opensearch Serverless Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Collection
Arn string - ARN of the OpenSearch Service vector store.
- Vector
Index stringName - Name of the vector store.
- Field
Mapping AgentKnowledge Base Storage Configuration Opensearch Serverless Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- collection
Arn String - ARN of the OpenSearch Service vector store.
- vector
Index StringName - Name of the vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Opensearch Serverless Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- collection
Arn string - ARN of the OpenSearch Service vector store.
- vector
Index stringName - Name of the vector store.
- field
Mapping AgentKnowledge Base Storage Configuration Opensearch Serverless Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- collection_
arn str - ARN of the OpenSearch Service vector store.
- vector_
index_ strname - Name of the vector store.
- field_
mapping AgentKnowledge Base Storage Configuration Opensearch Serverless Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- collection
Arn String - ARN of the OpenSearch Service vector store.
- vector
Index StringName - Name of the vector store.
- field
Mapping Property Map - The names of the fields to which to map information about the vector store. This block supports the following arguments:
AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationOpensearchServerlessConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - 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 - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
AgentKnowledgeBaseStorageConfigurationPineconeConfiguration, AgentKnowledgeBaseStorageConfigurationPineconeConfigurationArgs
- Connection
String string - Endpoint URL for your index management page.
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- Field
Mapping AgentKnowledge Base Storage Configuration Pinecone Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Namespace string
- Namespace to be used to write new data to your database.
- Connection
String string - Endpoint URL for your index management page.
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- Field
Mapping AgentKnowledge Base Storage Configuration Pinecone Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Namespace string
- Namespace to be used to write new data to your database.
- connection
String String - Endpoint URL for your index management page.
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping AgentKnowledge Base Storage Configuration Pinecone Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- namespace String
- Namespace to be used to write new data to your database.
- connection
String string - Endpoint URL for your index management page.
- credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping AgentKnowledge Base Storage Configuration Pinecone Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- namespace string
- Namespace to be used to write new data to your database.
- connection_
string str - Endpoint URL for your index management page.
- credentials_
secret_ strarn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field_
mapping AgentKnowledge Base Storage Configuration Pinecone Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- namespace str
- Namespace to be used to write new data to your database.
- connection
String String - Endpoint URL for your index management page.
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
- field
Mapping Property Map - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- namespace String
- Namespace to be used to write new data to your database.
AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationPineconeConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - 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 - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - 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
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- Database
Name string - Name of your Amazon RDS database.
- Resource
Arn string - ARN of the vector store.
- Table
Name string - Name of the table in the database.
- Field
Mapping AgentKnowledge Base Storage Configuration Rds Configuration Field Mapping - Names of the fields to which to map information about the vector store. This block supports the following arguments:
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- Database
Name string - Name of your Amazon RDS database.
- Resource
Arn string - ARN of the vector store.
- Table
Name string - Name of the table in the database.
- Field
Mapping AgentKnowledge Base Storage Configuration Rds Configuration Field Mapping - Names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name String - Name of your Amazon RDS database.
- resource
Arn String - ARN of the vector store.
- table
Name String - Name of the table in the database.
- field
Mapping AgentKnowledge Base Storage Configuration Rds Configuration Field Mapping - Names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name string - Name of your Amazon RDS database.
- resource
Arn string - ARN of the vector store.
- table
Name string - Name of the table in the database.
- field
Mapping AgentKnowledge Base Storage Configuration Rds Configuration Field Mapping - Names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials_
secret_ strarn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database_
name str - Name of your Amazon RDS database.
- resource_
arn str - ARN of the vector store.
- table_
name str - Name of the table in the database.
- field_
mapping AgentKnowledge Base Storage Configuration Rds Configuration Field Mapping - Names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
- database
Name String - Name of your Amazon RDS database.
- resource
Arn String - ARN of the vector store.
- table
Name String - Name of the table in the database.
- field
Mapping Property Map - Names of the fields to which to map information about the vector store. This block supports the following arguments:
AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationRdsConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key stringField - Name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Custom
Metadata stringField - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key stringField - Name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Custom
Metadata stringField - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key StringField - Name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- custom
Metadata StringField - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key stringField - Name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- custom
Metadata stringField - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
- metadata_
field str - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary_
key_ strfield - Name of the field in which Amazon Bedrock stores the ID for each entry.
- text_
field str - 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 - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- custom_
metadata_ strfield - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key StringField - Name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- custom
Metadata StringField - Name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfiguration, AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationArgs
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- Endpoint string
- Endpoint URL of the Redis Enterprise Cloud database.
- Vector
Index stringName - Name of the vector index.
- Field
Mapping AgentKnowledge Base Storage Configuration Redis Enterprise Cloud Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- Credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- Endpoint string
- Endpoint URL of the Redis Enterprise Cloud database.
- Vector
Index stringName - Name of the vector index.
- Field
Mapping AgentKnowledge Base Storage Configuration Redis Enterprise Cloud Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- endpoint String
- Endpoint URL of the Redis Enterprise Cloud database.
- vector
Index StringName - Name of the vector index.
- field
Mapping AgentKnowledge Base Storage Configuration Redis Enterprise Cloud Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret stringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- endpoint string
- Endpoint URL of the Redis Enterprise Cloud database.
- vector
Index stringName - Name of the vector index.
- field
Mapping AgentKnowledge Base Storage Configuration Redis Enterprise Cloud Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials_
secret_ strarn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- endpoint str
- Endpoint URL of the Redis Enterprise Cloud database.
- vector_
index_ strname - Name of the vector index.
- field_
mapping AgentKnowledge Base Storage Configuration Redis Enterprise Cloud Configuration Field Mapping - The names of the fields to which to map information about the vector store. This block supports the following arguments:
- credentials
Secret StringArn - ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
- endpoint String
- Endpoint URL of the Redis Enterprise Cloud database.
- vector
Index StringName - Name of the vector index.
- field
Mapping Property Map - The names of the fields to which to map information about the vector store. This block supports the following arguments:
AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMapping, AgentKnowledgeBaseStorageConfigurationRedisEnterpriseCloudConfigurationFieldMappingArgs
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- Metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- Vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field string - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field string - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field string - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata_
field str - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text_
field str - 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 - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- metadata
Field String - Name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field String - Name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vector
Field String - Name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
AgentKnowledgeBaseStorageConfigurationS3VectorsConfiguration, AgentKnowledgeBaseStorageConfigurationS3VectorsConfigurationArgs
- Index
Arn string - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - Index
Name string - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - Vector
Bucket stringArn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
- Index
Arn string - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - Index
Name string - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - Vector
Bucket stringArn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
- index
Arn String - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - index
Name String - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - vector
Bucket StringArn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
- index
Arn string - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - index
Name string - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - vector
Bucket stringArn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
- index_
arn str - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - index_
name str - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - vector_
bucket_ strarn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
- index
Arn String - ARN of the S3 Vectors index. Conflicts with
index_nameandvector_bucket_arn. - index
Name String - Name of the S3 Vectors index. Must be specified with
vector_bucket_arn. Conflicts withindex_arn. - vector
Bucket StringArn - ARN of the S3 Vectors vector bucket. Must be specified with
index_name. Conflicts withindex_arn.
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 knowledge base ID. For example:
$ pulumi import aws:bedrock/agentKnowledgeBase:AgentKnowledgeBase example EMDPPAYPZI
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
awsTerraform Provider.
