1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. KnowledgeBase

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.bedrock.KnowledgeBase

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Definition of AWS::Bedrock::KnowledgeBase Resource Type

Create KnowledgeBase Resource

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

Constructor syntax

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

@overload
def KnowledgeBase(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  knowledge_base_configuration: Optional[KnowledgeBaseConfigurationArgs] = None,
                  role_arn: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  storage_configuration: Optional[KnowledgeBaseStorageConfigurationArgs] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewKnowledgeBase(ctx *Context, name string, args KnowledgeBaseArgs, opts ...ResourceOption) (*KnowledgeBase, error)
public KnowledgeBase(string name, KnowledgeBaseArgs args, CustomResourceOptions? opts = null)
public KnowledgeBase(String name, KnowledgeBaseArgs args)
public KnowledgeBase(String name, KnowledgeBaseArgs args, CustomResourceOptions options)
type: aws-native:bedrock:KnowledgeBase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KnowledgeBaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KnowledgeBaseArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KnowledgeBaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KnowledgeBaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KnowledgeBaseArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

KnowledgeBase Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The KnowledgeBase resource accepts the following input properties:

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

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

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

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

knowledge_base_configuration This property is required. KnowledgeBaseConfigurationArgs
Contains details about the embeddings configuration of the knowledge base.
role_arn This property is required. str
The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
description str
Description of the Resource.
name str
The name of the knowledge base.
storage_configuration KnowledgeBaseStorageConfigurationArgs
Contains details about the storage configuration of the knowledge base.
tags Mapping[str, str]
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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

Outputs

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

CreatedAt string
The time at which the knowledge base was created.
FailureReasons List<string>
A list of reasons that the API operation on the knowledge base failed.
Id string
The provider-assigned unique ID for this managed resource.
KnowledgeBaseArn string
The ARN of the knowledge base.
KnowledgeBaseId string
The unique identifier of the knowledge base.
Status Pulumi.AwsNative.Bedrock.KnowledgeBaseStatus
The status of the knowledge base.
UpdatedAt string
The time at which the knowledge base was last updated.
CreatedAt string
The time at which the knowledge base was created.
FailureReasons []string
A list of reasons that the API operation on the knowledge base failed.
Id string
The provider-assigned unique ID for this managed resource.
KnowledgeBaseArn string
The ARN of the knowledge base.
KnowledgeBaseId string
The unique identifier of the knowledge base.
Status KnowledgeBaseStatus
The status of the knowledge base.
UpdatedAt string
The time at which the knowledge base was last updated.
createdAt String
The time at which the knowledge base was created.
failureReasons List<String>
A list of reasons that the API operation on the knowledge base failed.
id String
The provider-assigned unique ID for this managed resource.
knowledgeBaseArn String
The ARN of the knowledge base.
knowledgeBaseId String
The unique identifier of the knowledge base.
status KnowledgeBaseStatus
The status of the knowledge base.
updatedAt String
The time at which the knowledge base was last updated.
createdAt string
The time at which the knowledge base was created.
failureReasons string[]
A list of reasons that the API operation on the knowledge base failed.
id string
The provider-assigned unique ID for this managed resource.
knowledgeBaseArn string
The ARN of the knowledge base.
knowledgeBaseId string
The unique identifier of the knowledge base.
status KnowledgeBaseStatus
The status of the knowledge base.
updatedAt string
The time at which the knowledge base was last updated.
created_at str
The time at which the knowledge base was created.
failure_reasons Sequence[str]
A list of reasons that the API operation on the knowledge base failed.
id str
The provider-assigned unique ID for this managed resource.
knowledge_base_arn str
The ARN of the knowledge base.
knowledge_base_id str
The unique identifier of the knowledge base.
status KnowledgeBaseStatus
The status of the knowledge base.
updated_at str
The time at which the knowledge base was last updated.
createdAt String
The time at which the knowledge base was created.
failureReasons List<String>
A list of reasons that the API operation on the knowledge base failed.
id String
The provider-assigned unique ID for this managed resource.
knowledgeBaseArn String
The ARN of the knowledge base.
knowledgeBaseId String
The unique identifier of the knowledge base.
status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
The status of the knowledge base.
updatedAt String
The time at which the knowledge base was last updated.

Supporting Types

KnowledgeBaseBedrockEmbeddingModelConfiguration
, KnowledgeBaseBedrockEmbeddingModelConfigurationArgs

Dimensions int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
EmbeddingDataType Pulumi.AwsNative.Bedrock.KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
Dimensions int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
EmbeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions Integer
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions number
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embedding_data_type KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions Number
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType "FLOAT32" | "BINARY"
The data type for the vectors when using a model to convert text into vector embeddings.

KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
, KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataTypeArgs

Float32
FLOAT32
Binary
BINARY
KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataTypeFloat32
FLOAT32
KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataTypeBinary
BINARY
Float32
FLOAT32
Binary
BINARY
Float32
FLOAT32
Binary
BINARY
FLOAT32
FLOAT32
BINARY
BINARY
"FLOAT32"
FLOAT32
"BINARY"
BINARY

KnowledgeBaseConfiguration
, KnowledgeBaseConfigurationArgs

Type
This property is required.
Changes to this property will trigger replacement.
Pulumi.AwsNative.Bedrock.KnowledgeBaseType
The type of data that the data source is converted into for the knowledge base.
KendraKnowledgeBaseConfiguration Changes to this property will trigger replacement. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
SqlKnowledgeBaseConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.
VectorKnowledgeBaseConfiguration Changes to this property will trigger replacement. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.
Type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseType
The type of data that the data source is converted into for the knowledge base.
KendraKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
SqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.
VectorKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseType
The type of data that the data source is converted into for the knowledge base.
kendraKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
sqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.
vectorKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseType
The type of data that the data source is converted into for the knowledge base.
kendraKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
sqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.
vectorKnowledgeBaseConfiguration Changes to this property will trigger replacement. KnowledgeBaseVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseType
The type of data that the data source is converted into for the knowledge base.
kendra_knowledge_base_configuration Changes to this property will trigger replacement. KnowledgeBaseKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
sql_knowledge_base_configuration KnowledgeBaseSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.
vector_knowledge_base_configuration Changes to this property will trigger replacement. KnowledgeBaseVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.
type
This property is required.
Changes to this property will trigger replacement.
"VECTOR" | "KENDRA" | "SQL"
The type of data that the data source is converted into for the knowledge base.
kendraKnowledgeBaseConfiguration Changes to this property will trigger replacement. Property Map
Settings for an Amazon Kendra knowledge base.
sqlKnowledgeBaseConfiguration Property Map
Specifies configurations for a knowledge base connected to an SQL database.
vectorKnowledgeBaseConfiguration Changes to this property will trigger replacement. Property Map
Contains details about the model that's used to convert the data source into vector embeddings.

KnowledgeBaseCuratedQuery
, KnowledgeBaseCuratedQueryArgs

NaturalLanguage This property is required. string
Sql This property is required. string
NaturalLanguage This property is required. string
Sql This property is required. string
naturalLanguage This property is required. String
sql This property is required. String
naturalLanguage This property is required. string
sql This property is required. string
natural_language This property is required. str
sql This property is required. str
naturalLanguage This property is required. String
sql This property is required. String

KnowledgeBaseEmbeddingModelConfiguration
, KnowledgeBaseEmbeddingModelConfigurationArgs

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

KnowledgeBaseInclusionType
, KnowledgeBaseInclusionTypeArgs

Include
INCLUDE
Exclude
EXCLUDE
KnowledgeBaseInclusionTypeInclude
INCLUDE
KnowledgeBaseInclusionTypeExclude
EXCLUDE
Include
INCLUDE
Exclude
EXCLUDE
Include
INCLUDE
Exclude
EXCLUDE
INCLUDE
INCLUDE
EXCLUDE
EXCLUDE
"INCLUDE"
INCLUDE
"EXCLUDE"
EXCLUDE

KnowledgeBaseKendraKnowledgeBaseConfiguration
, KnowledgeBaseKendraKnowledgeBaseConfigurationArgs

KendraIndexArn This property is required. string
The ARN of the Amazon Kendra index.
KendraIndexArn This property is required. string
The ARN of the Amazon Kendra index.
kendraIndexArn This property is required. String
The ARN of the Amazon Kendra index.
kendraIndexArn This property is required. string
The ARN of the Amazon Kendra index.
kendra_index_arn This property is required. str
The ARN of the Amazon Kendra index.
kendraIndexArn This property is required. String
The ARN of the Amazon Kendra index.

KnowledgeBaseMongoDbAtlasConfiguration
, KnowledgeBaseMongoDbAtlasConfigurationArgs

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

KnowledgeBaseMongoDbAtlasFieldMapping
, KnowledgeBaseMongoDbAtlasFieldMappingArgs

MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadata_field This property is required. str
The name of the field in which Amazon Bedrock stores metadata about the vector store.
text_field This property is required. 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 This property is required. str
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

KnowledgeBaseOpenSearchServerlessConfiguration
, KnowledgeBaseOpenSearchServerlessConfigurationArgs

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

KnowledgeBaseOpenSearchServerlessFieldMapping
, KnowledgeBaseOpenSearchServerlessFieldMappingArgs

MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadata_field This property is required. str
The name of the field in which Amazon Bedrock stores metadata about the vector store.
text_field This property is required. 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 This property is required. str
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

KnowledgeBasePineconeConfiguration
, KnowledgeBasePineconeConfigurationArgs

ConnectionString This property is required. string
The endpoint URL for your index management page.
CredentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
FieldMapping This property is required. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBasePineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
Namespace string
The namespace to be used to write new data to your database.
ConnectionString This property is required. string
The endpoint URL for your index management page.
CredentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
FieldMapping This property is required. KnowledgeBasePineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
Namespace string
The namespace to be used to write new data to your database.
connectionString This property is required. String
The endpoint URL for your index management page.
credentialsSecretArn This property is required. String
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
fieldMapping This property is required. KnowledgeBasePineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
namespace String
The namespace to be used to write new data to your database.
connectionString This property is required. string
The endpoint URL for your index management page.
credentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
fieldMapping This property is required. KnowledgeBasePineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
namespace string
The namespace to be used to write new data to your database.
connection_string This property is required. str
The endpoint URL for your index management page.
credentials_secret_arn This property is required. str
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
field_mapping This property is required. KnowledgeBasePineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
namespace str
The namespace to be used to write new data to your database.
connectionString This property is required. String
The endpoint URL for your index management page.
credentialsSecretArn This property is required. String
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
fieldMapping This property is required. Property Map
Contains the names of the fields to which to map information about the vector store.
namespace String
The namespace to be used to write new data to your database.

KnowledgeBasePineconeFieldMapping
, KnowledgeBasePineconeFieldMappingArgs

MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
metadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
metadata_field This property is required. str
The name of the field in which Amazon Bedrock stores metadata about the vector store.
text_field This property is required. str
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
textField This property is required. 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.

KnowledgeBaseQueryEngineType
, KnowledgeBaseQueryEngineTypeArgs

Redshift
REDSHIFT
KnowledgeBaseQueryEngineTypeRedshift
REDSHIFT
Redshift
REDSHIFT
Redshift
REDSHIFT
REDSHIFT
REDSHIFT
"REDSHIFT"
REDSHIFT

KnowledgeBaseQueryGenerationColumn
, KnowledgeBaseQueryGenerationColumnArgs

KnowledgeBaseQueryGenerationConfiguration
, KnowledgeBaseQueryGenerationConfigurationArgs

ExecutionTimeoutSeconds int
The time after which query generation will time out.
GenerationContext Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseQueryGenerationContext
Specifies configurations for context to use during query generation.
ExecutionTimeoutSeconds int
The time after which query generation will time out.
GenerationContext KnowledgeBaseQueryGenerationContext
Specifies configurations for context to use during query generation.
executionTimeoutSeconds Integer
The time after which query generation will time out.
generationContext KnowledgeBaseQueryGenerationContext
Specifies configurations for context to use during query generation.
executionTimeoutSeconds number
The time after which query generation will time out.
generationContext KnowledgeBaseQueryGenerationContext
Specifies configurations for context to use during query generation.
execution_timeout_seconds int
The time after which query generation will time out.
generation_context KnowledgeBaseQueryGenerationContext
Specifies configurations for context to use during query generation.
executionTimeoutSeconds Number
The time after which query generation will time out.
generationContext Property Map
Specifies configurations for context to use during query generation.

KnowledgeBaseQueryGenerationContext
, KnowledgeBaseQueryGenerationContextArgs

CuratedQueries List<Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseCuratedQuery>
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
Tables List<Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseQueryGenerationTable>
An array of objects, each of which defines information about a table in the database.
CuratedQueries []KnowledgeBaseCuratedQuery
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
Tables []KnowledgeBaseQueryGenerationTable
An array of objects, each of which defines information about a table in the database.
curatedQueries List<KnowledgeBaseCuratedQuery>
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
tables List<KnowledgeBaseQueryGenerationTable>
An array of objects, each of which defines information about a table in the database.
curatedQueries KnowledgeBaseCuratedQuery[]
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
tables KnowledgeBaseQueryGenerationTable[]
An array of objects, each of which defines information about a table in the database.
curated_queries Sequence[KnowledgeBaseCuratedQuery]
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
tables Sequence[KnowledgeBaseQueryGenerationTable]
An array of objects, each of which defines information about a table in the database.
curatedQueries List<Property Map>
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
tables List<Property Map>
An array of objects, each of which defines information about a table in the database.

KnowledgeBaseQueryGenerationTable
, KnowledgeBaseQueryGenerationTableArgs

KnowledgeBaseRdsConfiguration
, KnowledgeBaseRdsConfigurationArgs

CredentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
DatabaseName This property is required. string
The name of your Amazon RDS database.
FieldMapping This property is required. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
ResourceArn This property is required. string
The ARN of the vector store.
TableName This property is required. string
The name of the table in the database.
CredentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
DatabaseName This property is required. string
The name of your Amazon RDS database.
FieldMapping This property is required. KnowledgeBaseRdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
ResourceArn This property is required. string
The ARN of the vector store.
TableName This property is required. string
The name of the table in the database.
credentialsSecretArn This property is required. String
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
databaseName This property is required. String
The name of your Amazon RDS database.
fieldMapping This property is required. KnowledgeBaseRdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
resourceArn This property is required. String
The ARN of the vector store.
tableName This property is required. String
The name of the table in the database.
credentialsSecretArn This property is required. string
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
databaseName This property is required. string
The name of your Amazon RDS database.
fieldMapping This property is required. KnowledgeBaseRdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
resourceArn This property is required. string
The ARN of the vector store.
tableName This property is required. string
The name of the table in the database.
credentials_secret_arn This property is required. str
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
database_name This property is required. str
The name of your Amazon RDS database.
field_mapping This property is required. KnowledgeBaseRdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
resource_arn This property is required. str
The ARN of the vector store.
table_name This property is required. str
The name of the table in the database.
credentialsSecretArn This property is required. String
The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
databaseName This property is required. String
The name of your Amazon RDS database.
fieldMapping This property is required. Property Map
Contains the names of the fields to which to map information about the vector store.
resourceArn This property is required. String
The ARN of the vector store.
tableName This property is required. String
The name of the table in the database.

KnowledgeBaseRdsFieldMapping
, KnowledgeBaseRdsFieldMappingArgs

MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
PrimaryKeyField This property is required. string
The name of the field in which Amazon Bedrock stores the ID for each entry.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
MetadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
PrimaryKeyField This property is required. string
The name of the field in which Amazon Bedrock stores the ID for each entry.
TextField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
VectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
primaryKeyField This property is required. String
The name of the field in which Amazon Bedrock stores the ID for each entry.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
primaryKeyField This property is required. string
The name of the field in which Amazon Bedrock stores the ID for each entry.
textField This property is required. string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadata_field This property is required. str
The name of the field in which Amazon Bedrock stores metadata about the vector store.
primary_key_field This property is required. str
The name of the field in which Amazon Bedrock stores the ID for each entry.
text_field This property is required. 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 This property is required. str
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
metadataField This property is required. String
The name of the field in which Amazon Bedrock stores metadata about the vector store.
primaryKeyField This property is required. String
The name of the field in which Amazon Bedrock stores the ID for each entry.
textField This property is required. String
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
vectorField This property is required. String
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

KnowledgeBaseRedshiftConfiguration
, KnowledgeBaseRedshiftConfigurationArgs

QueryEngineConfiguration
This property is required.
Changes to this property will trigger replacement.
Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftQueryEngineConfiguration
Specifies configurations for an Amazon Redshift query engine.
StorageConfigurations
This property is required.
Changes to this property will trigger replacement.
List<Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftQueryEngineStorageConfiguration>
Specifies configurations for Amazon Redshift database storage.
QueryGenerationConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseQueryGenerationConfiguration
Specifies configurations for generating queries.
QueryEngineConfiguration
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseRedshiftQueryEngineConfiguration
Specifies configurations for an Amazon Redshift query engine.
StorageConfigurations
This property is required.
Changes to this property will trigger replacement.
[]KnowledgeBaseRedshiftQueryEngineStorageConfiguration
Specifies configurations for Amazon Redshift database storage.
QueryGenerationConfiguration KnowledgeBaseQueryGenerationConfiguration
Specifies configurations for generating queries.
queryEngineConfiguration
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseRedshiftQueryEngineConfiguration
Specifies configurations for an Amazon Redshift query engine.
storageConfigurations
This property is required.
Changes to this property will trigger replacement.
List<KnowledgeBaseRedshiftQueryEngineStorageConfiguration>
Specifies configurations for Amazon Redshift database storage.
queryGenerationConfiguration KnowledgeBaseQueryGenerationConfiguration
Specifies configurations for generating queries.
queryEngineConfiguration
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseRedshiftQueryEngineConfiguration
Specifies configurations for an Amazon Redshift query engine.
storageConfigurations
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseRedshiftQueryEngineStorageConfiguration[]
Specifies configurations for Amazon Redshift database storage.
queryGenerationConfiguration KnowledgeBaseQueryGenerationConfiguration
Specifies configurations for generating queries.
query_engine_configuration
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseRedshiftQueryEngineConfiguration
Specifies configurations for an Amazon Redshift query engine.
storage_configurations
This property is required.
Changes to this property will trigger replacement.
Sequence[KnowledgeBaseRedshiftQueryEngineStorageConfiguration]
Specifies configurations for Amazon Redshift database storage.
query_generation_configuration KnowledgeBaseQueryGenerationConfiguration
Specifies configurations for generating queries.
queryEngineConfiguration
This property is required.
Changes to this property will trigger replacement.
Property Map
Specifies configurations for an Amazon Redshift query engine.
storageConfigurations
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Specifies configurations for Amazon Redshift database storage.
queryGenerationConfiguration Property Map
Specifies configurations for generating queries.

KnowledgeBaseRedshiftProvisionedAuthConfiguration
, KnowledgeBaseRedshiftProvisionedAuthConfigurationArgs

Type This property is required. Pulumi.AwsNative.Bedrock.KnowledgeBaseRedshiftProvisionedAuthType
The type of authentication to use.
DatabaseUser string
Redshift database user
UsernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
Type This property is required. KnowledgeBaseRedshiftProvisionedAuthType
The type of authentication to use.
DatabaseUser string
Redshift database user
UsernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftProvisionedAuthType
The type of authentication to use.
databaseUser String
Redshift database user
usernamePasswordSecretArn String
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftProvisionedAuthType
The type of authentication to use.
databaseUser string
Redshift database user
usernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftProvisionedAuthType
The type of authentication to use.
database_user str
Redshift database user
username_password_secret_arn str
The ARN of an Secrets Manager secret for authentication.
type This property is required. "IAM" | "USERNAME_PASSWORD" | "USERNAME"
The type of authentication to use.
databaseUser String
Redshift database user
usernamePasswordSecretArn String
The ARN of an Secrets Manager secret for authentication.

KnowledgeBaseRedshiftProvisionedAuthType
, KnowledgeBaseRedshiftProvisionedAuthTypeArgs

Iam
IAM
UsernamePassword
USERNAME_PASSWORD
Username
USERNAME
KnowledgeBaseRedshiftProvisionedAuthTypeIam
IAM
KnowledgeBaseRedshiftProvisionedAuthTypeUsernamePassword
USERNAME_PASSWORD
KnowledgeBaseRedshiftProvisionedAuthTypeUsername
USERNAME
Iam
IAM
UsernamePassword
USERNAME_PASSWORD
Username
USERNAME
Iam
IAM
UsernamePassword
USERNAME_PASSWORD
Username
USERNAME
IAM
IAM
USERNAME_PASSWORD
USERNAME_PASSWORD
USERNAME
USERNAME
"IAM"
IAM
"USERNAME_PASSWORD"
USERNAME_PASSWORD
"USERNAME"
USERNAME

KnowledgeBaseRedshiftProvisionedConfiguration
, KnowledgeBaseRedshiftProvisionedConfigurationArgs

AuthConfiguration This property is required. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftProvisionedAuthConfiguration
Specifies configurations for authentication to Amazon Redshift.
ClusterIdentifier This property is required. string
The ID of the Amazon Redshift cluster.
AuthConfiguration This property is required. KnowledgeBaseRedshiftProvisionedAuthConfiguration
Specifies configurations for authentication to Amazon Redshift.
ClusterIdentifier This property is required. string
The ID of the Amazon Redshift cluster.
authConfiguration This property is required. KnowledgeBaseRedshiftProvisionedAuthConfiguration
Specifies configurations for authentication to Amazon Redshift.
clusterIdentifier This property is required. String
The ID of the Amazon Redshift cluster.
authConfiguration This property is required. KnowledgeBaseRedshiftProvisionedAuthConfiguration
Specifies configurations for authentication to Amazon Redshift.
clusterIdentifier This property is required. string
The ID of the Amazon Redshift cluster.
auth_configuration This property is required. KnowledgeBaseRedshiftProvisionedAuthConfiguration
Specifies configurations for authentication to Amazon Redshift.
cluster_identifier This property is required. str
The ID of the Amazon Redshift cluster.
authConfiguration This property is required. Property Map
Specifies configurations for authentication to Amazon Redshift.
clusterIdentifier This property is required. String
The ID of the Amazon Redshift cluster.

KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration
, KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfigurationArgs

TableNames This property is required. List<string>
TableNames This property is required. []string
tableNames This property is required. List<String>
tableNames This property is required. string[]
table_names This property is required. Sequence[str]
tableNames This property is required. List<String>

KnowledgeBaseRedshiftQueryEngineConfiguration
, KnowledgeBaseRedshiftQueryEngineConfigurationArgs

Type This property is required. Pulumi.AwsNative.Bedrock.KnowledgeBaseRedshiftQueryEngineType
The type of query engine.
ProvisionedConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftProvisionedConfiguration
Specifies configurations for a provisioned Amazon Redshift query engine.
ServerlessConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftServerlessConfiguration
Specifies configurations for a serverless Amazon Redshift query engine.
Type This property is required. KnowledgeBaseRedshiftQueryEngineType
The type of query engine.
ProvisionedConfiguration KnowledgeBaseRedshiftProvisionedConfiguration
Specifies configurations for a provisioned Amazon Redshift query engine.
ServerlessConfiguration KnowledgeBaseRedshiftServerlessConfiguration
Specifies configurations for a serverless Amazon Redshift query engine.
type This property is required. KnowledgeBaseRedshiftQueryEngineType
The type of query engine.
provisionedConfiguration KnowledgeBaseRedshiftProvisionedConfiguration
Specifies configurations for a provisioned Amazon Redshift query engine.
serverlessConfiguration KnowledgeBaseRedshiftServerlessConfiguration
Specifies configurations for a serverless Amazon Redshift query engine.
type This property is required. KnowledgeBaseRedshiftQueryEngineType
The type of query engine.
provisionedConfiguration KnowledgeBaseRedshiftProvisionedConfiguration
Specifies configurations for a provisioned Amazon Redshift query engine.
serverlessConfiguration KnowledgeBaseRedshiftServerlessConfiguration
Specifies configurations for a serverless Amazon Redshift query engine.
type This property is required. KnowledgeBaseRedshiftQueryEngineType
The type of query engine.
provisioned_configuration KnowledgeBaseRedshiftProvisionedConfiguration
Specifies configurations for a provisioned Amazon Redshift query engine.
serverless_configuration KnowledgeBaseRedshiftServerlessConfiguration
Specifies configurations for a serverless Amazon Redshift query engine.
type This property is required. "SERVERLESS" | "PROVISIONED"
The type of query engine.
provisionedConfiguration Property Map
Specifies configurations for a provisioned Amazon Redshift query engine.
serverlessConfiguration Property Map
Specifies configurations for a serverless Amazon Redshift query engine.

KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration
, KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfigurationArgs

DatabaseName This property is required. string
DatabaseName This property is required. string
databaseName This property is required. String
databaseName This property is required. string
database_name This property is required. str
databaseName This property is required. String

KnowledgeBaseRedshiftQueryEngineStorageConfiguration
, KnowledgeBaseRedshiftQueryEngineStorageConfigurationArgs

KnowledgeBaseRedshiftQueryEngineStorageType
, KnowledgeBaseRedshiftQueryEngineStorageTypeArgs

Redshift
REDSHIFT
AwsDataCatalog
AWS_DATA_CATALOG
KnowledgeBaseRedshiftQueryEngineStorageTypeRedshift
REDSHIFT
KnowledgeBaseRedshiftQueryEngineStorageTypeAwsDataCatalog
AWS_DATA_CATALOG
Redshift
REDSHIFT
AwsDataCatalog
AWS_DATA_CATALOG
Redshift
REDSHIFT
AwsDataCatalog
AWS_DATA_CATALOG
REDSHIFT
REDSHIFT
AWS_DATA_CATALOG
AWS_DATA_CATALOG
"REDSHIFT"
REDSHIFT
"AWS_DATA_CATALOG"
AWS_DATA_CATALOG

KnowledgeBaseRedshiftQueryEngineType
, KnowledgeBaseRedshiftQueryEngineTypeArgs

Serverless
SERVERLESS
Provisioned
PROVISIONED
KnowledgeBaseRedshiftQueryEngineTypeServerless
SERVERLESS
KnowledgeBaseRedshiftQueryEngineTypeProvisioned
PROVISIONED
Serverless
SERVERLESS
Provisioned
PROVISIONED
Serverless
SERVERLESS
Provisioned
PROVISIONED
SERVERLESS
SERVERLESS
PROVISIONED
PROVISIONED
"SERVERLESS"
SERVERLESS
"PROVISIONED"
PROVISIONED

KnowledgeBaseRedshiftServerlessAuthConfiguration
, KnowledgeBaseRedshiftServerlessAuthConfigurationArgs

Type This property is required. Pulumi.AwsNative.Bedrock.KnowledgeBaseRedshiftServerlessAuthType
The type of authentication to use.
UsernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
Type This property is required. KnowledgeBaseRedshiftServerlessAuthType
The type of authentication to use.
UsernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftServerlessAuthType
The type of authentication to use.
usernamePasswordSecretArn String
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftServerlessAuthType
The type of authentication to use.
usernamePasswordSecretArn string
The ARN of an Secrets Manager secret for authentication.
type This property is required. KnowledgeBaseRedshiftServerlessAuthType
The type of authentication to use.
username_password_secret_arn str
The ARN of an Secrets Manager secret for authentication.
type This property is required. "IAM" | "USERNAME_PASSWORD"
The type of authentication to use.
usernamePasswordSecretArn String
The ARN of an Secrets Manager secret for authentication.

KnowledgeBaseRedshiftServerlessAuthType
, KnowledgeBaseRedshiftServerlessAuthTypeArgs

Iam
IAM
UsernamePassword
USERNAME_PASSWORD
KnowledgeBaseRedshiftServerlessAuthTypeIam
IAM
KnowledgeBaseRedshiftServerlessAuthTypeUsernamePassword
USERNAME_PASSWORD
Iam
IAM
UsernamePassword
USERNAME_PASSWORD
Iam
IAM
UsernamePassword
USERNAME_PASSWORD
IAM
IAM
USERNAME_PASSWORD
USERNAME_PASSWORD
"IAM"
IAM
"USERNAME_PASSWORD"
USERNAME_PASSWORD

KnowledgeBaseRedshiftServerlessConfiguration
, KnowledgeBaseRedshiftServerlessConfigurationArgs

AuthConfiguration This property is required. Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftServerlessAuthConfiguration
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
WorkgroupArn This property is required. string
The ARN of the Amazon Redshift workgroup.
AuthConfiguration This property is required. KnowledgeBaseRedshiftServerlessAuthConfiguration
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
WorkgroupArn This property is required. string
The ARN of the Amazon Redshift workgroup.
authConfiguration This property is required. KnowledgeBaseRedshiftServerlessAuthConfiguration
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
workgroupArn This property is required. String
The ARN of the Amazon Redshift workgroup.
authConfiguration This property is required. KnowledgeBaseRedshiftServerlessAuthConfiguration
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
workgroupArn This property is required. string
The ARN of the Amazon Redshift workgroup.
auth_configuration This property is required. KnowledgeBaseRedshiftServerlessAuthConfiguration
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
workgroup_arn This property is required. str
The ARN of the Amazon Redshift workgroup.
authConfiguration This property is required. Property Map
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
workgroupArn This property is required. String
The ARN of the Amazon Redshift workgroup.

KnowledgeBaseS3Location
, KnowledgeBaseS3LocationArgs

Uri This property is required. string
The location's URI
Uri This property is required. string
The location's URI
uri This property is required. String
The location's URI
uri This property is required. string
The location's URI
uri This property is required. str
The location's URI
uri This property is required. String
The location's URI

KnowledgeBaseSqlKnowledgeBaseConfiguration
, KnowledgeBaseSqlKnowledgeBaseConfigurationArgs

Type
This property is required.
Changes to this property will trigger replacement.
Pulumi.AwsNative.Bedrock.KnowledgeBaseQueryEngineType
The type of SQL database to connect to the knowledge base.
RedshiftConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRedshiftConfiguration
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
Type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseQueryEngineType
The type of SQL database to connect to the knowledge base.
RedshiftConfiguration KnowledgeBaseRedshiftConfiguration
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseQueryEngineType
The type of SQL database to connect to the knowledge base.
redshiftConfiguration KnowledgeBaseRedshiftConfiguration
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseQueryEngineType
The type of SQL database to connect to the knowledge base.
redshiftConfiguration KnowledgeBaseRedshiftConfiguration
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
type
This property is required.
Changes to this property will trigger replacement.
KnowledgeBaseQueryEngineType
The type of SQL database to connect to the knowledge base.
redshift_configuration KnowledgeBaseRedshiftConfiguration
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
type
This property is required.
Changes to this property will trigger replacement.
"REDSHIFT"
The type of SQL database to connect to the knowledge base.
redshiftConfiguration Property Map
Specifies configurations for a knowledge base connected to an Amazon Redshift database.

KnowledgeBaseStatus
, KnowledgeBaseStatusArgs

Creating
CREATING
Active
ACTIVE
Deleting
DELETING
Updating
UPDATING
Failed
FAILED
DeleteUnsuccessful
DELETE_UNSUCCESSFUL
KnowledgeBaseStatusCreating
CREATING
KnowledgeBaseStatusActive
ACTIVE
KnowledgeBaseStatusDeleting
DELETING
KnowledgeBaseStatusUpdating
UPDATING
KnowledgeBaseStatusFailed
FAILED
KnowledgeBaseStatusDeleteUnsuccessful
DELETE_UNSUCCESSFUL
Creating
CREATING
Active
ACTIVE
Deleting
DELETING
Updating
UPDATING
Failed
FAILED
DeleteUnsuccessful
DELETE_UNSUCCESSFUL
Creating
CREATING
Active
ACTIVE
Deleting
DELETING
Updating
UPDATING
Failed
FAILED
DeleteUnsuccessful
DELETE_UNSUCCESSFUL
CREATING
CREATING
ACTIVE
ACTIVE
DELETING
DELETING
UPDATING
UPDATING
FAILED
FAILED
DELETE_UNSUCCESSFUL
DELETE_UNSUCCESSFUL
"CREATING"
CREATING
"ACTIVE"
ACTIVE
"DELETING"
DELETING
"UPDATING"
UPDATING
"FAILED"
FAILED
"DELETE_UNSUCCESSFUL"
DELETE_UNSUCCESSFUL

KnowledgeBaseStorageConfiguration
, KnowledgeBaseStorageConfigurationArgs

Type This property is required. Pulumi.AwsNative.Bedrock.KnowledgeBaseStorageType
The vector store service in which the knowledge base is stored.
MongoDbAtlasConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
OpensearchServerlessConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseOpenSearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
PineconeConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBasePineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
RdsConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
Type This property is required. KnowledgeBaseStorageType
The vector store service in which the knowledge base is stored.
MongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
OpensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
PineconeConfiguration KnowledgeBasePineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
RdsConfiguration KnowledgeBaseRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
type This property is required. KnowledgeBaseStorageType
The vector store service in which the knowledge base is stored.
mongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
opensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
pineconeConfiguration KnowledgeBasePineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
rdsConfiguration KnowledgeBaseRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
type This property is required. KnowledgeBaseStorageType
The vector store service in which the knowledge base is stored.
mongoDbAtlasConfiguration KnowledgeBaseMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
opensearchServerlessConfiguration KnowledgeBaseOpenSearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
pineconeConfiguration KnowledgeBasePineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
rdsConfiguration KnowledgeBaseRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
type This property is required. KnowledgeBaseStorageType
The vector store service in which the knowledge base is stored.
mongo_db_atlas_configuration KnowledgeBaseMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
opensearch_serverless_configuration KnowledgeBaseOpenSearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
pinecone_configuration KnowledgeBasePineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
rds_configuration KnowledgeBaseRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
type This property is required. "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS"
The vector store service in which the knowledge base is stored.
mongoDbAtlasConfiguration Property Map
Contains the storage configuration of the knowledge base in MongoDB Atlas.
opensearchServerlessConfiguration Property Map
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
pineconeConfiguration Property Map
Contains the storage configuration of the knowledge base in Pinecone.
rdsConfiguration Property Map
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .

KnowledgeBaseStorageType
, KnowledgeBaseStorageTypeArgs

OpensearchServerless
OPENSEARCH_SERVERLESS
Pinecone
PINECONE
Rds
RDS
MongoDbAtlas
MONGO_DB_ATLAS
KnowledgeBaseStorageTypeOpensearchServerless
OPENSEARCH_SERVERLESS
KnowledgeBaseStorageTypePinecone
PINECONE
KnowledgeBaseStorageTypeRds
RDS
KnowledgeBaseStorageTypeMongoDbAtlas
MONGO_DB_ATLAS
OpensearchServerless
OPENSEARCH_SERVERLESS
Pinecone
PINECONE
Rds
RDS
MongoDbAtlas
MONGO_DB_ATLAS
OpensearchServerless
OPENSEARCH_SERVERLESS
Pinecone
PINECONE
Rds
RDS
MongoDbAtlas
MONGO_DB_ATLAS
OPENSEARCH_SERVERLESS
OPENSEARCH_SERVERLESS
PINECONE
PINECONE
RDS
RDS
MONGO_DB_ATLAS
MONGO_DB_ATLAS
"OPENSEARCH_SERVERLESS"
OPENSEARCH_SERVERLESS
"PINECONE"
PINECONE
"RDS"
RDS
"MONGO_DB_ATLAS"
MONGO_DB_ATLAS

KnowledgeBaseSupplementalDataStorageConfiguration
, KnowledgeBaseSupplementalDataStorageConfigurationArgs

KnowledgeBaseSupplementalDataStorageLocation
, KnowledgeBaseSupplementalDataStorageLocationArgs

KnowledgeBaseSupplementalDataStorageLocationType
, KnowledgeBaseSupplementalDataStorageLocationTypeArgs

S3
S3
KnowledgeBaseSupplementalDataStorageLocationTypeS3
S3
S3
S3
S3
S3
S3
S3
"S3"
S3

KnowledgeBaseType
, KnowledgeBaseTypeArgs

Vector
VECTOR
Kendra
KENDRA
Sql
SQL
KnowledgeBaseTypeVector
VECTOR
KnowledgeBaseTypeKendra
KENDRA
KnowledgeBaseTypeSql
SQL
Vector
VECTOR
Kendra
KENDRA
Sql
SQL
Vector
VECTOR
Kendra
KENDRA
Sql
SQL
VECTOR
VECTOR
KENDRA
KENDRA
SQL
SQL
"VECTOR"
VECTOR
"KENDRA"
KENDRA
"SQL"
SQL

KnowledgeBaseVectorKnowledgeBaseConfiguration
, KnowledgeBaseVectorKnowledgeBaseConfigurationArgs

EmbeddingModelArn This property is required. string
The ARN of the model used to create vector embeddings for the knowledge base.
EmbeddingModelConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseEmbeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
SupplementalDataStorageConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseSupplementalDataStorageConfiguration
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
EmbeddingModelArn This property is required. string
The ARN of the model used to create vector embeddings for the knowledge base.
EmbeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
SupplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
embeddingModelArn This property is required. String
The ARN of the model used to create vector embeddings for the knowledge base.
embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
supplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
embeddingModelArn This property is required. string
The ARN of the model used to create vector embeddings for the knowledge base.
embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
supplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
embedding_model_arn This property is required. str
The ARN of the model used to create vector embeddings for the knowledge base.
embedding_model_configuration KnowledgeBaseEmbeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
supplemental_data_storage_configuration KnowledgeBaseSupplementalDataStorageConfiguration
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
embeddingModelArn This property is required. String
The ARN of the model used to create vector embeddings for the knowledge base.
embeddingModelConfiguration Property Map
The embeddings model configuration details for the vector model used in Knowledge Base.
supplementalDataStorageConfiguration Property Map
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi