We recommend new projects start with resources from the AWS provider.
aws-native.bedrock.KnowledgeBase
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Bedrock::KnowledgeBase Resource Type
Create KnowledgeBase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KnowledgeBase(name: string, args: KnowledgeBaseArgs, opts?: CustomResourceOptions);
@overload
def KnowledgeBase(resource_name: str,
args: KnowledgeBaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KnowledgeBase(resource_name: str,
opts: Optional[ResourceOptions] = None,
knowledge_base_configuration: Optional[KnowledgeBaseConfigurationArgs] = None,
role_arn: Optional[str] = None,
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:
- Knowledge
Base Configuration This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Configuration - Contains details about the embeddings configuration of the knowledge base.
- Role
Arn 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.
- Storage
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Storage Configuration - Contains details about the storage configuration of the knowledge base.
- Dictionary<string, string>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Knowledge
Base Configuration This property is required. KnowledgeBase Configuration Args - Contains details about the embeddings configuration of the knowledge base.
- Role
Arn 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.
- Storage
Configuration KnowledgeBase Storage Configuration Args - Contains details about the storage configuration of the knowledge base.
- map[string]string
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base Configuration This property is required. KnowledgeBase Configuration - Contains details about the embeddings configuration of the knowledge base.
- role
Arn 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.
- storage
Configuration KnowledgeBase Storage Configuration - Contains details about the storage configuration of the knowledge base.
- Map<String,String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base Configuration This property is required. KnowledgeBase Configuration - Contains details about the embeddings configuration of the knowledge base.
- role
Arn 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.
- storage
Configuration KnowledgeBase Storage Configuration - Contains details about the storage configuration of the knowledge base.
- {[key: string]: string}
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge_
base_ configuration This property is required. KnowledgeBase Configuration Args - 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 KnowledgeBase Storage Configuration Args - Contains details about the storage configuration of the knowledge base.
- Mapping[str, str]
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- knowledge
Base Configuration This property is required. Property Map - Contains details about the embeddings configuration of the knowledge base.
- role
Arn 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.
- storage
Configuration Property Map - Contains details about the storage configuration of the knowledge base.
- Map<String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
Outputs
All input properties are implicitly available as output properties. Additionally, the KnowledgeBase resource produces the following output properties:
- Created
At string - The time at which the knowledge base was created.
- Failure
Reasons List<string> - A list of reasons that the API operation on the knowledge base failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Status
Pulumi.
Aws Native. Bedrock. Knowledge Base Status - The status of the knowledge base.
- Updated
At string - The time at which the knowledge base was last updated.
- Created
At string - The time at which the knowledge base was created.
- Failure
Reasons []string - A list of reasons that the API operation on the knowledge base failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Status
Knowledge
Base Status - The status of the knowledge base.
- Updated
At string - The time at which the knowledge base was last updated.
- created
At String - The time at which the knowledge base was created.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated
At String - The time at which the knowledge base was last updated.
- created
At string - The time at which the knowledge base was created.
- failure
Reasons string[] - A list of reasons that the API operation on the knowledge base failed.
- id string
- The provider-assigned unique ID for this managed resource.
- knowledge
Base stringArn - The ARN of the knowledge base.
- knowledge
Base stringId - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated
At string - The time at which the knowledge base was last updated.
- created_
at str - The time at which the knowledge base was created.
- failure_
reasons Sequence[str] - A list of reasons that the API operation on the knowledge base failed.
- id str
- The provider-assigned unique ID for this managed resource.
- knowledge_
base_ strarn - The ARN of the knowledge base.
- knowledge_
base_ strid - The unique identifier of the knowledge base.
- status
Knowledge
Base Status - The status of the knowledge base.
- updated_
at str - The time at which the knowledge base was last updated.
- created
At String - The time at which the knowledge base was created.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
- The status of the knowledge base.
- updated
At String - The time at which the knowledge base was last updated.
Supporting Types
KnowledgeBaseBedrockEmbeddingModelConfiguration, KnowledgeBaseBedrockEmbeddingModelConfigurationArgs
- Dimensions int
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- Embedding
Data Pulumi.Type Aws Native. Bedrock. Knowledge Base Bedrock Embedding Model Configuration Embedding Data Type - 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 KnowledgeType Base Bedrock Embedding Model Configuration Embedding Data Type - 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.
- embedding
Data KnowledgeType Base Bedrock Embedding Model Configuration Embedding Data Type - 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.
- embedding
Data KnowledgeType Base Bedrock Embedding Model Configuration Embedding Data Type - 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_ Knowledgetype Base Bedrock Embedding Model Configuration Embedding Data Type - 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.
- embedding
Data "FLOAT32" | "BINARY"Type - The data type for the vectors when using a model to convert text into vector embeddings.
KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType, KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataTypeArgs
- Float32
- FLOAT32
- Binary
- BINARY
- Knowledge
Base Bedrock Embedding Model Configuration Embedding Data Type Float32 - FLOAT32
- Knowledge
Base Bedrock Embedding Model Configuration Embedding Data Type Binary - 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.
Aws Native. Bedrock. Knowledge Base Type - 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.
Aws Native. Bedrock. Inputs. Knowledge Base Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base.
- Sql
Knowledge Pulumi.Base Configuration Aws Native. Bedrock. Inputs. Knowledge Base Sql Knowledge Base Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- Vector
Knowledge Base Configuration Changes to this property will trigger replacement.
Aws Native. Bedrock. Inputs. Knowledge Base Vector Knowledge Base Configuration - Contains details about the model that's used to convert the data source into vector embeddings.
- Type
This property is required. Changes to this property will trigger replacement.
Base Type - 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.
Base Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base.
- Sql
Knowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- Vector
Knowledge Base Configuration Changes to this property will trigger replacement.
Base Vector Knowledge Base Configuration - 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.
Base Type - 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.
Base Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base.
- sql
Knowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- vector
Knowledge Base Configuration Changes to this property will trigger replacement.
Base Vector Knowledge Base Configuration - 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.
Base Type - 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.
Base Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base.
- sql
Knowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- vector
Knowledge Base Configuration Changes to this property will trigger replacement.
Base Vector Knowledge Base Configuration - 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.
Base Type - 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.
Base Kendra Knowledge Base Configuration - Settings for an Amazon Kendra knowledge base.
- sql_
knowledge_ Knowledgebase_ configuration Base Sql Knowledge Base Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- vector_
knowledge_ base_ configuration Changes to this property will trigger replacement.
Base Vector Knowledge Base Configuration - 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.
- 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.
- Settings for an Amazon Kendra knowledge base.
- sql
Knowledge Property MapBase Configuration - Specifies configurations for a knowledge base connected to an SQL database.
- vector
Knowledge Base Configuration Changes to this property will trigger replacement.
- Contains details about the model that's used to convert the data source into vector embeddings.
KnowledgeBaseCuratedQuery, KnowledgeBaseCuratedQueryArgs
- Natural
Language This property is required. string - Sql
This property is required. string
- Natural
Language This property is required. string - Sql
This property is required. string
- natural
Language This property is required. String - sql
This property is required. String
- natural
Language This property is required. string - sql
This property is required. string
- natural_
language This property is required. str - sql
This property is required. str
- natural
Language This property is required. String - sql
This property is required. String
KnowledgeBaseEmbeddingModelConfiguration, KnowledgeBaseEmbeddingModelConfigurationArgs
- Bedrock
Embedding Pulumi.Model Configuration Aws Native. Bedrock. Inputs. Knowledge Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- Bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock_
embedding_ Knowledgemodel_ configuration Base Bedrock Embedding Model Configuration - The vector configuration details on the Bedrock embeddings model.
- bedrock
Embedding Property MapModel Configuration - The vector configuration details on the Bedrock embeddings model.
KnowledgeBaseInclusionType, KnowledgeBaseInclusionTypeArgs
- Include
- INCLUDE
- Exclude
- EXCLUDE
- Knowledge
Base Inclusion Type Include - INCLUDE
- Knowledge
Base Inclusion Type Exclude - EXCLUDE
- Include
- INCLUDE
- Exclude
- EXCLUDE
- Include
- INCLUDE
- Exclude
- EXCLUDE
- INCLUDE
- INCLUDE
- EXCLUDE
- EXCLUDE
- "INCLUDE"
- INCLUDE
- "EXCLUDE"
- EXCLUDE
KnowledgeBaseKendraKnowledgeBaseConfiguration, KnowledgeBaseKendraKnowledgeBaseConfigurationArgs
- Kendra
Index Arn This property is required. string - The ARN of the Amazon Kendra index.
- Kendra
Index Arn This property is required. string - The ARN of the Amazon Kendra index.
- kendra
Index Arn This property is required. String - The ARN of the Amazon Kendra index.
- kendra
Index Arn 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.
- kendra
Index Arn This property is required. String - The ARN of the Amazon Kendra index.
KnowledgeBaseMongoDbAtlasConfiguration, KnowledgeBaseMongoDbAtlasConfigurationArgs
- Collection
Name This property is required. string - Name of the collection within MongoDB Atlas.
- Credentials
Secret Arn 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.
- Database
Name This property is required. string - Name of the database within MongoDB Atlas.
- Endpoint
This property is required. string - MongoDB Atlas endpoint.
- Field
Mapping This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index Name This property is required. string - Name of a MongoDB Atlas index.
- Endpoint
Service stringName - MongoDB Atlas endpoint service name.
- Collection
Name This property is required. string - Name of the collection within MongoDB Atlas.
- Credentials
Secret Arn 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.
- Database
Name This property is required. string - Name of the database within MongoDB Atlas.
- Endpoint
This property is required. string - MongoDB Atlas endpoint.
- Field
Mapping This property is required. KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index Name This property is required. string - Name of a MongoDB Atlas index.
- Endpoint
Service stringName - MongoDB Atlas endpoint service name.
- collection
Name This property is required. String - Name of the collection within MongoDB Atlas.
- credentials
Secret Arn 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.
- database
Name This property is required. String - Name of the database within MongoDB Atlas.
- endpoint
This property is required. String - MongoDB Atlas endpoint.
- field
Mapping This property is required. KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name This property is required. String - Name of a MongoDB Atlas index.
- endpoint
Service StringName - MongoDB Atlas endpoint service name.
- collection
Name This property is required. string - Name of the collection within MongoDB Atlas.
- credentials
Secret Arn 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.
- database
Name This property is required. string - Name of the database within MongoDB Atlas.
- endpoint
This property is required. string - MongoDB Atlas endpoint.
- field
Mapping This property is required. KnowledgeBase Mongo Db Atlas Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name This property is required. string - Name of a MongoDB Atlas index.
- endpoint
Service stringName - 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. KnowledgeBase Mongo Db Atlas Field Mapping - 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_ strname - MongoDB Atlas endpoint service name.
- collection
Name This property is required. String - Name of the collection within MongoDB Atlas.
- credentials
Secret Arn 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.
- database
Name This property is required. String - Name of the database within MongoDB Atlas.
- endpoint
This property is required. String - MongoDB Atlas endpoint.
- field
Mapping This property is required. Property Map - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name This property is required. String - Name of a MongoDB Atlas index.
- endpoint
Service StringName - MongoDB Atlas endpoint service name.
KnowledgeBaseMongoDbAtlasFieldMapping, KnowledgeBaseMongoDbAtlasFieldMappingArgs
- Metadata
Field This property is required. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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.
- Vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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.
- Vector
Field 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. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field 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.
- metadata
Field This property is required. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field This property is required. String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBaseOpenSearchServerlessConfiguration, KnowledgeBaseOpenSearchServerlessConfigurationArgs
- Collection
Arn This property is required. string - The ARN of the OpenSearch Service vector store.
- Field
Mapping This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index Name This property is required. string - The name of the vector store.
- Collection
Arn This property is required. string - The ARN of the OpenSearch Service vector store.
- Field
Mapping This property is required. KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Vector
Index Name This property is required. string - The name of the vector store.
- collection
Arn This property is required. String - The ARN of the OpenSearch Service vector store.
- field
Mapping This property is required. KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name This property is required. String - The name of the vector store.
- collection
Arn This property is required. string - The ARN of the OpenSearch Service vector store.
- field
Mapping This property is required. KnowledgeBase Open Search Serverless Field Mapping - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name 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. KnowledgeBase Open Search Serverless Field Mapping - 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.
- collection
Arn This property is required. String - The ARN of the OpenSearch Service vector store.
- field
Mapping This property is required. Property Map - Contains the names of the fields to which to map information about the vector store.
- vector
Index Name This property is required. String - The name of the vector store.
KnowledgeBaseOpenSearchServerlessFieldMapping, KnowledgeBaseOpenSearchServerlessFieldMappingArgs
- Metadata
Field This property is required. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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.
- Vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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.
- Vector
Field 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. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field 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.
- metadata
Field This property is required. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- vector
Field This property is required. String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBasePineconeConfiguration, KnowledgeBasePineconeConfigurationArgs
- Connection
String This property is required. string - The endpoint URL for your index management page.
- Credentials
Secret Arn 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.
- Field
Mapping This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Namespace string
- The namespace to be used to write new data to your database.
- Connection
String This property is required. string - The endpoint URL for your index management page.
- Credentials
Secret Arn 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.
- Field
Mapping This property is required. KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Namespace string
- The namespace to be used to write new data to your database.
- connection
String This property is required. String - The endpoint URL for your index management page.
- credentials
Secret Arn 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.
- field
Mapping This property is required. KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace String
- The namespace to be used to write new data to your database.
- connection
String This property is required. string - The endpoint URL for your index management page.
- credentials
Secret Arn 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.
- field
Mapping This property is required. KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace string
- The namespace to be used to write new data to your database.
- connection_
string 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. KnowledgeBase Pinecone Field Mapping - Contains the names of the fields to which to map information about the vector store.
- namespace str
- The namespace to be used to write new data to your database.
- connection
String This property is required. String - The endpoint URL for your index management page.
- credentials
Secret Arn 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.
- field
Mapping 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
- Metadata
Field This property is required. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Text
Field 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. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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.
- metadata
Field This property is required. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- text
Field 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
- Knowledge
Base Query Engine Type Redshift - REDSHIFT
- Redshift
- REDSHIFT
- Redshift
- REDSHIFT
- REDSHIFT
- REDSHIFT
- "REDSHIFT"
- REDSHIFT
KnowledgeBaseQueryGenerationColumn, KnowledgeBaseQueryGenerationColumnArgs
- Description string
- Inclusion
Knowledge
Base Inclusion Type - Name string
- description String
- inclusion
Knowledge
Base Inclusion Type - name String
- description string
- inclusion
Knowledge
Base Inclusion Type - name string
- description String
- inclusion "INCLUDE" | "EXCLUDE"
- name String
KnowledgeBaseQueryGenerationConfiguration, KnowledgeBaseQueryGenerationConfigurationArgs
- Execution
Timeout intSeconds - The time after which query generation will time out.
- Generation
Context Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Context - Specifies configurations for context to use during query generation.
- Execution
Timeout intSeconds - The time after which query generation will time out.
- Generation
Context KnowledgeBase Query Generation Context - Specifies configurations for context to use during query generation.
- execution
Timeout IntegerSeconds - The time after which query generation will time out.
- generation
Context KnowledgeBase Query Generation Context - Specifies configurations for context to use during query generation.
- execution
Timeout numberSeconds - The time after which query generation will time out.
- generation
Context KnowledgeBase Query Generation Context - Specifies configurations for context to use during query generation.
- execution_
timeout_ intseconds - The time after which query generation will time out.
- generation_
context KnowledgeBase Query Generation Context - Specifies configurations for context to use during query generation.
- execution
Timeout NumberSeconds - The time after which query generation will time out.
- generation
Context Property Map - Specifies configurations for context to use during query generation.
KnowledgeBaseQueryGenerationContext, KnowledgeBaseQueryGenerationContextArgs
- Curated
Queries List<Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Curated Query> - An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
- Tables
List<Pulumi.
Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Table> - An array of objects, each of which defines information about a table in the database.
- Curated
Queries []KnowledgeBase Curated Query - An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
- Tables
[]Knowledge
Base Query Generation Table - An array of objects, each of which defines information about a table in the database.
- curated
Queries List<KnowledgeBase Curated Query> - An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
- tables
List<Knowledge
Base Query Generation Table> - An array of objects, each of which defines information about a table in the database.
- curated
Queries KnowledgeBase Curated Query[] - An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
- tables
Knowledge
Base Query Generation Table[] - An array of objects, each of which defines information about a table in the database.
- curated_
queries Sequence[KnowledgeBase Curated Query] - An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
- tables
Sequence[Knowledge
Base Query Generation Table] - An array of objects, each of which defines information about a table in the database.
- curated
Queries 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
- Name
This property is required. string - Columns
List<Pulumi.
Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Column> - Description string
- Inclusion
Pulumi.
Aws Native. Bedrock. Knowledge Base Inclusion Type
- Name
This property is required. string - Columns
[]Knowledge
Base Query Generation Column - Description string
- Inclusion
Knowledge
Base Inclusion Type
- name
This property is required. String - columns
List<Knowledge
Base Query Generation Column> - description String
- inclusion
Knowledge
Base Inclusion Type
- name
This property is required. string - columns
Knowledge
Base Query Generation Column[] - description string
- inclusion
Knowledge
Base Inclusion Type
- name
This property is required. str - columns
Sequence[Knowledge
Base Query Generation Column] - description str
- inclusion
Knowledge
Base Inclusion Type
- name
This property is required. String - columns List<Property Map>
- description String
- inclusion "INCLUDE" | "EXCLUDE"
KnowledgeBaseRdsConfiguration, KnowledgeBaseRdsConfigurationArgs
- Credentials
Secret Arn 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.
- Database
Name This property is required. string - The name of your Amazon RDS database.
- Field
Mapping This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Resource
Arn This property is required. string - The ARN of the vector store.
- Table
Name This property is required. string - The name of the table in the database.
- Credentials
Secret Arn 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.
- Database
Name This property is required. string - The name of your Amazon RDS database.
- Field
Mapping This property is required. KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- Resource
Arn This property is required. string - The ARN of the vector store.
- Table
Name This property is required. string - The name of the table in the database.
- credentials
Secret Arn 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.
- database
Name This property is required. String - The name of your Amazon RDS database.
- field
Mapping This property is required. KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- resource
Arn This property is required. String - The ARN of the vector store.
- table
Name This property is required. String - The name of the table in the database.
- credentials
Secret Arn 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.
- database
Name This property is required. string - The name of your Amazon RDS database.
- field
Mapping This property is required. KnowledgeBase Rds Field Mapping - Contains the names of the fields to which to map information about the vector store.
- resource
Arn This property is required. string - The ARN of the vector store.
- table
Name 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. KnowledgeBase Rds Field Mapping - 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.
- credentials
Secret Arn 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.
- database
Name This property is required. String - The name of your Amazon RDS database.
- field
Mapping This property is required. Property Map - Contains the names of the fields to which to map information about the vector store.
- resource
Arn This property is required. String - The ARN of the vector store.
- table
Name This property is required. String - The name of the table in the database.
KnowledgeBaseRdsFieldMapping, KnowledgeBaseRdsFieldMappingArgs
- Metadata
Field This property is required. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key Field This property is required. string - The name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field 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.
- Vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- Primary
Key Field This property is required. string - The name of the field in which Amazon Bedrock stores the ID for each entry.
- Text
Field 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.
- Vector
Field 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. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key Field This property is required. String - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field 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.
- vector
Field 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. string - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key Field This property is required. string - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field 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.
- vector
Field 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.
- metadata
Field This property is required. String - The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primary
Key Field This property is required. String - The name of the field in which Amazon Bedrock stores the ID for each entry.
- text
Field 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.
- vector
Field This property is required. String - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
KnowledgeBaseRedshiftConfiguration, KnowledgeBaseRedshiftConfigurationArgs
- Query
Engine Configuration This property is required. Changes to this property will trigger replacement.
Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Configuration - Specifies configurations for an Amazon Redshift query engine.
- Storage
Configurations This property is required. Changes to this property will trigger replacement.
Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Storage Configuration> - Specifies configurations for Amazon Redshift database storage.
- Query
Generation Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Configuration - Specifies configurations for generating queries.
- Query
Engine Configuration This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Configuration - Specifies configurations for an Amazon Redshift query engine.
- Storage
Configurations This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Storage Configuration - Specifies configurations for Amazon Redshift database storage.
- Query
Generation KnowledgeConfiguration Base Query Generation Configuration - Specifies configurations for generating queries.
- query
Engine Configuration This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Configuration - Specifies configurations for an Amazon Redshift query engine.
- storage
Configurations This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Storage Configuration> - Specifies configurations for Amazon Redshift database storage.
- query
Generation KnowledgeConfiguration Base Query Generation Configuration - Specifies configurations for generating queries.
- query
Engine Configuration This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Configuration - Specifies configurations for an Amazon Redshift query engine.
- storage
Configurations This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Storage Configuration[] - Specifies configurations for Amazon Redshift database storage.
- query
Generation KnowledgeConfiguration Base Query Generation Configuration - Specifies configurations for generating queries.
- query_
engine_ configuration This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Configuration - Specifies configurations for an Amazon Redshift query engine.
- storage_
configurations This property is required. Changes to this property will trigger replacement.
Base Redshift Query Engine Storage Configuration] - Specifies configurations for Amazon Redshift database storage.
- query_
generation_ Knowledgeconfiguration Base Query Generation Configuration - Specifies configurations for generating queries.
- query
Engine Configuration This property is required. Changes to this property will trigger replacement.
- Specifies configurations for an Amazon Redshift query engine.
- storage
Configurations This property is required. Changes to this property will trigger replacement.
- Specifies configurations for Amazon Redshift database storage.
- query
Generation Property MapConfiguration - Specifies configurations for generating queries.
KnowledgeBaseRedshiftProvisionedAuthConfiguration, KnowledgeBaseRedshiftProvisionedAuthConfigurationArgs
- Type
This property is required. Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Provisioned Auth Type - The type of authentication to use.
- Database
User string - Redshift database user
- Username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- Type
This property is required. KnowledgeBase Redshift Provisioned Auth Type - The type of authentication to use.
- Database
User string - Redshift database user
- Username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Provisioned Auth Type - The type of authentication to use.
- database
User String - Redshift database user
- username
Password StringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Provisioned Auth Type - The type of authentication to use.
- database
User string - Redshift database user
- username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Provisioned Auth Type - The type of authentication to use.
- database_
user str - Redshift database user
- username_
password_ strsecret_ arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. "IAM" | "USERNAME_PASSWORD" | "USERNAME" - The type of authentication to use.
- database
User String - Redshift database user
- username
Password StringSecret Arn - The ARN of an Secrets Manager secret for authentication.
KnowledgeBaseRedshiftProvisionedAuthType, KnowledgeBaseRedshiftProvisionedAuthTypeArgs
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- Username
- USERNAME
- Knowledge
Base Redshift Provisioned Auth Type Iam - IAM
- Knowledge
Base Redshift Provisioned Auth Type Username Password - USERNAME_PASSWORD
- Knowledge
Base Redshift Provisioned Auth Type Username - USERNAME
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- Username
- USERNAME
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- Username
- USERNAME
- IAM
- IAM
- USERNAME_PASSWORD
- USERNAME_PASSWORD
- USERNAME
- USERNAME
- "IAM"
- IAM
- "USERNAME_PASSWORD"
- USERNAME_PASSWORD
- "USERNAME"
- USERNAME
KnowledgeBaseRedshiftProvisionedConfiguration, KnowledgeBaseRedshiftProvisionedConfigurationArgs
- Auth
Configuration This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Provisioned Auth Configuration - Specifies configurations for authentication to Amazon Redshift.
- Cluster
Identifier This property is required. string - The ID of the Amazon Redshift cluster.
- Auth
Configuration This property is required. KnowledgeBase Redshift Provisioned Auth Configuration - Specifies configurations for authentication to Amazon Redshift.
- Cluster
Identifier This property is required. string - The ID of the Amazon Redshift cluster.
- auth
Configuration This property is required. KnowledgeBase Redshift Provisioned Auth Configuration - Specifies configurations for authentication to Amazon Redshift.
- cluster
Identifier This property is required. String - The ID of the Amazon Redshift cluster.
- auth
Configuration This property is required. KnowledgeBase Redshift Provisioned Auth Configuration - Specifies configurations for authentication to Amazon Redshift.
- cluster
Identifier This property is required. string - The ID of the Amazon Redshift cluster.
- auth_
configuration This property is required. KnowledgeBase Redshift Provisioned Auth Configuration - Specifies configurations for authentication to Amazon Redshift.
- cluster_
identifier This property is required. str - The ID of the Amazon Redshift cluster.
- auth
Configuration This property is required. Property Map - Specifies configurations for authentication to Amazon Redshift.
- cluster
Identifier This property is required. String - The ID of the Amazon Redshift cluster.
KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration, KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfigurationArgs
- Table
Names This property is required. List<string>
- Table
Names This property is required. []string
- table
Names This property is required. List<String>
- table
Names This property is required. string[]
- table_
names This property is required. Sequence[str]
- table
Names This property is required. List<String>
KnowledgeBaseRedshiftQueryEngineConfiguration, KnowledgeBaseRedshiftQueryEngineConfigurationArgs
- Type
This property is required. Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Query Engine Type - The type of query engine.
- Provisioned
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Provisioned Configuration - Specifies configurations for a provisioned Amazon Redshift query engine.
- Serverless
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Serverless Configuration - Specifies configurations for a serverless Amazon Redshift query engine.
- Type
This property is required. KnowledgeBase Redshift Query Engine Type - The type of query engine.
- Provisioned
Configuration KnowledgeBase Redshift Provisioned Configuration - Specifies configurations for a provisioned Amazon Redshift query engine.
- Serverless
Configuration KnowledgeBase Redshift Serverless Configuration - Specifies configurations for a serverless Amazon Redshift query engine.
- type
This property is required. KnowledgeBase Redshift Query Engine Type - The type of query engine.
- provisioned
Configuration KnowledgeBase Redshift Provisioned Configuration - Specifies configurations for a provisioned Amazon Redshift query engine.
- serverless
Configuration KnowledgeBase Redshift Serverless Configuration - Specifies configurations for a serverless Amazon Redshift query engine.
- type
This property is required. KnowledgeBase Redshift Query Engine Type - The type of query engine.
- provisioned
Configuration KnowledgeBase Redshift Provisioned Configuration - Specifies configurations for a provisioned Amazon Redshift query engine.
- serverless
Configuration KnowledgeBase Redshift Serverless Configuration - Specifies configurations for a serverless Amazon Redshift query engine.
- type
This property is required. KnowledgeBase Redshift Query Engine Type - The type of query engine.
- provisioned_
configuration KnowledgeBase Redshift Provisioned Configuration - Specifies configurations for a provisioned Amazon Redshift query engine.
- serverless_
configuration KnowledgeBase Redshift Serverless Configuration - Specifies configurations for a serverless Amazon Redshift query engine.
- type
This property is required. "SERVERLESS" | "PROVISIONED" - The type of query engine.
- provisioned
Configuration Property Map - Specifies configurations for a provisioned Amazon Redshift query engine.
- serverless
Configuration Property Map - Specifies configurations for a serverless Amazon Redshift query engine.
KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration, KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfigurationArgs
- Database
Name This property is required. string
- Database
Name This property is required. string
- database
Name This property is required. String
- database
Name This property is required. string
- database_
name This property is required. str
- database
Name This property is required. String
KnowledgeBaseRedshiftQueryEngineStorageConfiguration, KnowledgeBaseRedshiftQueryEngineStorageConfigurationArgs
- Type
This property is required. Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Query Engine Storage Type - Aws
Data Pulumi.Catalog Configuration Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Aws Data Catalog Storage Configuration - Redshift
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Redshift Storage Configuration
- type
This property is required. "REDSHIFT" | "AWS_DATA_CATALOG" - aws
Data Property MapCatalog Configuration - redshift
Configuration Property Map
KnowledgeBaseRedshiftQueryEngineStorageType, KnowledgeBaseRedshiftQueryEngineStorageTypeArgs
- Redshift
- REDSHIFT
- Aws
Data Catalog - AWS_DATA_CATALOG
- Knowledge
Base Redshift Query Engine Storage Type Redshift - REDSHIFT
- Knowledge
Base Redshift Query Engine Storage Type Aws Data Catalog - AWS_DATA_CATALOG
- Redshift
- REDSHIFT
- Aws
Data Catalog - AWS_DATA_CATALOG
- Redshift
- REDSHIFT
- Aws
Data Catalog - 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
- Knowledge
Base Redshift Query Engine Type Serverless - SERVERLESS
- Knowledge
Base Redshift Query Engine Type Provisioned - 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.Aws Native. Bedrock. Knowledge Base Redshift Serverless Auth Type - The type of authentication to use.
- Username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- Type
This property is required. KnowledgeBase Redshift Serverless Auth Type - The type of authentication to use.
- Username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Serverless Auth Type - The type of authentication to use.
- username
Password StringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Serverless Auth Type - The type of authentication to use.
- username
Password stringSecret Arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. KnowledgeBase Redshift Serverless Auth Type - The type of authentication to use.
- username_
password_ strsecret_ arn - The ARN of an Secrets Manager secret for authentication.
- type
This property is required. "IAM" | "USERNAME_PASSWORD" - The type of authentication to use.
- username
Password StringSecret Arn - The ARN of an Secrets Manager secret for authentication.
KnowledgeBaseRedshiftServerlessAuthType, KnowledgeBaseRedshiftServerlessAuthTypeArgs
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- Knowledge
Base Redshift Serverless Auth Type Iam - IAM
- Knowledge
Base Redshift Serverless Auth Type Username Password - USERNAME_PASSWORD
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- Iam
- IAM
- Username
Password - USERNAME_PASSWORD
- IAM
- IAM
- USERNAME_PASSWORD
- USERNAME_PASSWORD
- "IAM"
- IAM
- "USERNAME_PASSWORD"
- USERNAME_PASSWORD
KnowledgeBaseRedshiftServerlessConfiguration, KnowledgeBaseRedshiftServerlessConfigurationArgs
- Auth
Configuration This property is required. Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Serverless Auth Configuration - Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- Workgroup
Arn This property is required. string - The ARN of the Amazon Redshift workgroup.
- Auth
Configuration This property is required. KnowledgeBase Redshift Serverless Auth Configuration - Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- Workgroup
Arn This property is required. string - The ARN of the Amazon Redshift workgroup.
- auth
Configuration This property is required. KnowledgeBase Redshift Serverless Auth Configuration - Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroup
Arn This property is required. String - The ARN of the Amazon Redshift workgroup.
- auth
Configuration This property is required. KnowledgeBase Redshift Serverless Auth Configuration - Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroup
Arn This property is required. string - The ARN of the Amazon Redshift workgroup.
- auth_
configuration This property is required. KnowledgeBase Redshift Serverless Auth Configuration - 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.
- auth
Configuration This property is required. Property Map - Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroup
Arn 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.
Aws Native. Bedrock. Knowledge Base Query Engine Type - The type of SQL database to connect to the knowledge base.
- Redshift
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Configuration - Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- Type
This property is required. Changes to this property will trigger replacement.
Base Query Engine Type - The type of SQL database to connect to the knowledge base.
- Redshift
Configuration KnowledgeBase Redshift Configuration - Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
This property is required. Changes to this property will trigger replacement.
Base Query Engine Type - The type of SQL database to connect to the knowledge base.
- redshift
Configuration KnowledgeBase Redshift Configuration - Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
This property is required. Changes to this property will trigger replacement.
Base Query Engine Type - The type of SQL database to connect to the knowledge base.
- redshift
Configuration KnowledgeBase Redshift Configuration - Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
This property is required. Changes to this property will trigger replacement.
Base Query Engine Type - The type of SQL database to connect to the knowledge base.
- redshift_
configuration KnowledgeBase Redshift Configuration - Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
This property is required. Changes to this property will trigger replacement.
- The type of SQL database to connect to the knowledge base.
- redshift
Configuration 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
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Knowledge
Base Status Creating - CREATING
- Knowledge
Base Status Active - ACTIVE
- Knowledge
Base Status Deleting - DELETING
- Knowledge
Base Status Updating - UPDATING
- Knowledge
Base Status Failed - FAILED
- Knowledge
Base Status Delete Unsuccessful - DELETE_UNSUCCESSFUL
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Updating
- UPDATING
- Failed
- FAILED
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Updating
- UPDATING
- Failed
- FAILED
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- CREATING
- CREATING
- ACTIVE
- ACTIVE
- DELETING
- DELETING
- UPDATING
- UPDATING
- FAILED
- FAILED
- DELETE_UNSUCCESSFUL
- DELETE_UNSUCCESSFUL
- "CREATING"
- CREATING
- "ACTIVE"
- ACTIVE
- "DELETING"
- DELETING
- "UPDATING"
- UPDATING
- "FAILED"
- FAILED
- "DELETE_UNSUCCESSFUL"
- DELETE_UNSUCCESSFUL
KnowledgeBaseStorageConfiguration, KnowledgeBaseStorageConfigurationArgs
- Type
This property is required. Pulumi.Aws Native. Bedrock. Knowledge Base Storage Type - The vector store service in which the knowledge base is stored.
- Mongo
Db Pulumi.Atlas Configuration Aws Native. Bedrock. Inputs. Knowledge Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- Opensearch
Serverless Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- Pinecone
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- Rds
Configuration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- Type
This property is required. KnowledgeBase Storage Type - The vector store service in which the knowledge base is stored.
- Mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- Opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- Pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- Rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
This property is required. KnowledgeBase Storage Type - The vector store service in which the knowledge base is stored.
- mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
This property is required. KnowledgeBase Storage Type - The vector store service in which the knowledge base is stored.
- mongo
Db KnowledgeAtlas Configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless KnowledgeConfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
This property is required. KnowledgeBase Storage Type - The vector store service in which the knowledge base is stored.
- mongo_
db_ Knowledgeatlas_ configuration Base Mongo Db Atlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch_
serverless_ Knowledgeconfiguration Base Open Search Serverless Configuration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone_
configuration KnowledgeBase Pinecone Configuration - Contains the storage configuration of the knowledge base in Pinecone.
- rds_
configuration KnowledgeBase Rds Configuration - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
- type
This property is required. "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS" - The vector store service in which the knowledge base is stored.
- mongo
Db Property MapAtlas Configuration - Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearch
Serverless Property MapConfiguration - Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pinecone
Configuration Property Map - Contains the storage configuration of the knowledge base in Pinecone.
- rds
Configuration Property Map - Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS .
KnowledgeBaseStorageType, KnowledgeBaseStorageTypeArgs
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- Knowledge
Base Storage Type Opensearch Serverless - OPENSEARCH_SERVERLESS
- Knowledge
Base Storage Type Pinecone - PINECONE
- Knowledge
Base Storage Type Rds - RDS
- Knowledge
Base Storage Type Mongo Db Atlas - MONGO_DB_ATLAS
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- Opensearch
Serverless - OPENSEARCH_SERVERLESS
- Pinecone
- PINECONE
- Rds
- RDS
- Mongo
Db Atlas - MONGO_DB_ATLAS
- OPENSEARCH_SERVERLESS
- OPENSEARCH_SERVERLESS
- PINECONE
- PINECONE
- RDS
- RDS
- MONGO_DB_ATLAS
- MONGO_DB_ATLAS
- "OPENSEARCH_SERVERLESS"
- OPENSEARCH_SERVERLESS
- "PINECONE"
- PINECONE
- "RDS"
- RDS
- "MONGO_DB_ATLAS"
- MONGO_DB_ATLAS
KnowledgeBaseSupplementalDataStorageConfiguration, KnowledgeBaseSupplementalDataStorageConfigurationArgs
- Supplemental
Data Storage Locations This property is required. []KnowledgeBase Supplemental Data Storage Location
- supplemental
Data Storage Locations This property is required. List<KnowledgeBase Supplemental Data Storage Location>
- supplemental
Data Storage Locations This property is required. KnowledgeBase Supplemental Data Storage Location[]
- supplemental_
data_ storage_ locations This property is required. Sequence[KnowledgeBase Supplemental Data Storage Location]
- supplemental
Data Storage Locations This property is required. List<Property Map>
KnowledgeBaseSupplementalDataStorageLocation, KnowledgeBaseSupplementalDataStorageLocationArgs
- Supplemental
Data Storage Location Type This property is required. KnowledgeBase Supplemental Data Storage Location Type - S3Location
Knowledge
Base S3Location
- supplemental
Data Storage Location Type This property is required. KnowledgeBase Supplemental Data Storage Location Type - s3Location
Knowledge
Base S3Location
- supplemental
Data Storage Location Type This property is required. KnowledgeBase Supplemental Data Storage Location Type - s3Location
Knowledge
Base S3Location
- supplemental
Data Storage Location Type This property is required. "S3" - s3Location Property Map
KnowledgeBaseSupplementalDataStorageLocationType, KnowledgeBaseSupplementalDataStorageLocationTypeArgs
- S3
- S3
- Knowledge
Base Supplemental Data Storage Location Type S3 - S3
- S3
- S3
- S3
- S3
- S3
- S3
- "S3"
- S3
KnowledgeBaseType, KnowledgeBaseTypeArgs
- Vector
- VECTOR
- Kendra
- KENDRA
- Sql
- SQL
- Knowledge
Base Type Vector - VECTOR
- Knowledge
Base Type Kendra - KENDRA
- Knowledge
Base Type Sql - 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
- Embedding
Model Arn This property is required. string - The ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- Supplemental
Data Pulumi.Storage Configuration Aws Native. Bedrock. Inputs. Knowledge Base Supplemental Data Storage Configuration - 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. string - The ARN of the model used to create vector embeddings for the knowledge base.
- Embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- Supplemental
Data KnowledgeStorage Configuration Base Supplemental Data Storage Configuration - 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. String - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- supplemental
Data KnowledgeStorage Configuration Base Supplemental Data Storage Configuration - 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. string - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model KnowledgeConfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- supplemental
Data KnowledgeStorage Configuration Base Supplemental Data Storage Configuration - 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_ Knowledgeconfiguration Base Embedding Model Configuration - The embeddings model configuration details for the vector model used in Knowledge Base.
- supplemental_
data_ Knowledgestorage_ configuration Base Supplemental Data Storage Configuration - 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. String - The ARN of the model used to create vector embeddings for the knowledge base.
- embedding
Model Property MapConfiguration - The embeddings model configuration details for the vector model used in Knowledge Base.
- supplemental
Data Property MapStorage Configuration - 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.