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.getKnowledgeBase
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
Using getKnowledgeBase
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getKnowledgeBase(args: GetKnowledgeBaseArgs, opts?: InvokeOptions): Promise<GetKnowledgeBaseResult>
function getKnowledgeBaseOutput(args: GetKnowledgeBaseOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeBaseResult>def get_knowledge_base(knowledge_base_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKnowledgeBaseResult
def get_knowledge_base_output(knowledge_base_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeBaseResult]func LookupKnowledgeBase(ctx *Context, args *LookupKnowledgeBaseArgs, opts ...InvokeOption) (*LookupKnowledgeBaseResult, error)
func LookupKnowledgeBaseOutput(ctx *Context, args *LookupKnowledgeBaseOutputArgs, opts ...InvokeOption) LookupKnowledgeBaseResultOutput> Note: This function is named LookupKnowledgeBase in the Go SDK.
public static class GetKnowledgeBase 
{
    public static Task<GetKnowledgeBaseResult> InvokeAsync(GetKnowledgeBaseArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgeBaseResult> Invoke(GetKnowledgeBaseInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
public static Output<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
fn::invoke:
  function: aws-native:bedrock:getKnowledgeBase
  arguments:
    # arguments dictionaryThe following arguments are supported:
- KnowledgeBase stringId 
- The unique identifier of the knowledge base.
- KnowledgeBase stringId 
- The unique identifier of the knowledge base.
- knowledgeBase StringId 
- The unique identifier of the knowledge base.
- knowledgeBase stringId 
- The unique identifier of the knowledge base.
- knowledge_base_ strid 
- The unique identifier of the knowledge base.
- knowledgeBase StringId 
- The unique identifier of the knowledge base.
getKnowledgeBase Result
The following output properties are available:
- CreatedAt string
- The time at which the knowledge base was created.
- Description string
- Description of the Resource.
- FailureReasons List<string>
- A list of reasons that the API operation on the knowledge base failed.
- KnowledgeBase stringArn 
- The ARN of the knowledge base.
- KnowledgeBase Pulumi.Configuration Aws Native. Bedrock. Outputs. Knowledge Base Configuration 
- Contains details about the embeddings configuration of the knowledge base.
- KnowledgeBase stringId 
- The unique identifier of the knowledge base.
- Name string
- The name of the knowledge base.
- RoleArn string
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- Status
Pulumi.Aws Native. Bedrock. Knowledge Base Status 
- The status 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:
- UpdatedAt string
- The time at which the knowledge base was last updated.
- CreatedAt string
- The time at which the knowledge base was created.
- Description string
- Description of the Resource.
- FailureReasons []string
- A list of reasons that the API operation on the knowledge base failed.
- KnowledgeBase stringArn 
- The ARN of the knowledge base.
- KnowledgeBase KnowledgeConfiguration Base Configuration 
- Contains details about the embeddings configuration of the knowledge base.
- KnowledgeBase stringId 
- The unique identifier of the knowledge base.
- Name string
- The name of the knowledge base.
- RoleArn string
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- Status
KnowledgeBase Status 
- The status 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:
- UpdatedAt string
- The time at which the knowledge base was last updated.
- createdAt String
- The time at which the knowledge base was created.
- description String
- Description of the Resource.
- failureReasons List<String>
- A list of reasons that the API operation on the knowledge base failed.
- knowledgeBase StringArn 
- The ARN of the knowledge base.
- knowledgeBase KnowledgeConfiguration Base Configuration 
- Contains details about the embeddings configuration of the knowledge base.
- knowledgeBase StringId 
- The unique identifier of the knowledge base.
- name String
- The name of the knowledge base.
- roleArn String
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status
KnowledgeBase Status 
- The status 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:
- updatedAt String
- The time at which the knowledge base was last updated.
- createdAt string
- The time at which the knowledge base was created.
- description string
- Description of the Resource.
- failureReasons string[]
- A list of reasons that the API operation on the knowledge base failed.
- knowledgeBase stringArn 
- The ARN of the knowledge base.
- knowledgeBase KnowledgeConfiguration Base Configuration 
- Contains details about the embeddings configuration of the knowledge base.
- knowledgeBase stringId 
- The unique identifier of the knowledge base.
- name string
- The name of the knowledge base.
- roleArn string
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status
KnowledgeBase Status 
- The status 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:
- updatedAt string
- The time at which the knowledge base was last updated.
- created_at str
- The time at which the knowledge base was created.
- description str
- Description of the Resource.
- failure_reasons Sequence[str]
- A list of reasons that the API operation on the knowledge base failed.
- knowledge_base_ strarn 
- The ARN of the knowledge base.
- knowledge_base_ Knowledgeconfiguration Base Configuration 
- Contains details about the embeddings configuration of the knowledge base.
- knowledge_base_ strid 
- The unique identifier of the knowledge base.
- name str
- The name of the knowledge base.
- role_arn str
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status
KnowledgeBase Status 
- The status 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:
- updated_at str
- The time at which the knowledge base was last updated.
- createdAt String
- The time at which the knowledge base was created.
- description String
- Description of the Resource.
- failureReasons List<String>
- A list of reasons that the API operation on the knowledge base failed.
- knowledgeBase StringArn 
- The ARN of the knowledge base.
- knowledgeBase Property MapConfiguration 
- Contains details about the embeddings configuration of the knowledge base.
- knowledgeBase StringId 
- The unique identifier of the knowledge base.
- name String
- The name of the knowledge base.
- roleArn String
- The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
- The status 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:
- updatedAt String
- The time at which the knowledge base was last updated.
Supporting Types
KnowledgeBaseBedrockEmbeddingModelConfiguration     
- Dimensions int
- The dimensions details for the vector configuration used on the Bedrock embeddings model.
- EmbeddingData 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.
- EmbeddingData 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.
- embeddingData 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.
- embeddingData 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.
- embeddingData "FLOAT32" | "BINARY"Type 
- The data type for the vectors when using a model to convert text into vector embeddings.
KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType        
KnowledgeBaseConfiguration  
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Type 
- The type of data that the data source is converted into for the knowledge base.
- KendraKnowledge Pulumi.Base Configuration Aws Native. Bedrock. Inputs. Knowledge Base Kendra Knowledge Base Configuration 
- Settings for an Amazon Kendra knowledge base.
- SqlKnowledge Pulumi.Base Configuration Aws Native. Bedrock. Inputs. Knowledge Base Sql Knowledge Base Configuration 
- Specifies configurations for a knowledge base connected to an SQL database.
- VectorKnowledge Pulumi.Base Configuration 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
KnowledgeBase Type 
- The type of data that the data source is converted into for the knowledge base.
- KendraKnowledge KnowledgeBase Configuration Base Kendra Knowledge Base Configuration 
- Settings for an Amazon Kendra knowledge base.
- SqlKnowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration 
- Specifies configurations for a knowledge base connected to an SQL database.
- VectorKnowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration 
- Contains details about the model that's used to convert the data source into vector embeddings.
- type
KnowledgeBase Type 
- The type of data that the data source is converted into for the knowledge base.
- kendraKnowledge KnowledgeBase Configuration Base Kendra Knowledge Base Configuration 
- Settings for an Amazon Kendra knowledge base.
- sqlKnowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration 
- Specifies configurations for a knowledge base connected to an SQL database.
- vectorKnowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration 
- Contains details about the model that's used to convert the data source into vector embeddings.
- type
KnowledgeBase Type 
- The type of data that the data source is converted into for the knowledge base.
- kendraKnowledge KnowledgeBase Configuration Base Kendra Knowledge Base Configuration 
- Settings for an Amazon Kendra knowledge base.
- sqlKnowledge KnowledgeBase Configuration Base Sql Knowledge Base Configuration 
- Specifies configurations for a knowledge base connected to an SQL database.
- vectorKnowledge KnowledgeBase Configuration Base Vector Knowledge Base Configuration 
- Contains details about the model that's used to convert the data source into vector embeddings.
- type
KnowledgeBase Type 
- The type of data that the data source is converted into for the knowledge base.
- kendra_knowledge_ Knowledgebase_ configuration 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_ Knowledgebase_ configuration Base Vector Knowledge Base Configuration 
- Contains details about the model that's used to convert the data source into vector embeddings.
- type "VECTOR" | "KENDRA" | "SQL"
- The type of data that the data source is converted into for the knowledge base.
- kendraKnowledge Property MapBase Configuration 
- Settings for an Amazon Kendra knowledge base.
- sqlKnowledge Property MapBase Configuration 
- Specifies configurations for a knowledge base connected to an SQL database.
- vectorKnowledge Property MapBase Configuration 
- Contains details about the model that's used to convert the data source into vector embeddings.
KnowledgeBaseCuratedQuery   
- NaturalLanguage string
- Sql string
- NaturalLanguage string
- Sql string
- naturalLanguage String
- sql String
- naturalLanguage string
- sql string
- natural_language str
- sql str
- naturalLanguage String
- sql String
KnowledgeBaseEmbeddingModelConfiguration    
- BedrockEmbedding Pulumi.Model Configuration Aws Native. Bedrock. Inputs. Knowledge Base Bedrock Embedding Model Configuration 
- The vector configuration details on the Bedrock embeddings model.
- BedrockEmbedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration 
- The vector configuration details on the Bedrock embeddings model.
- bedrockEmbedding KnowledgeModel Configuration Base Bedrock Embedding Model Configuration 
- The vector configuration details on the Bedrock embeddings model.
- bedrockEmbedding 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.
- bedrockEmbedding Property MapModel Configuration 
- The vector configuration details on the Bedrock embeddings model.
KnowledgeBaseInclusionType   
KnowledgeBaseKendraKnowledgeBaseConfiguration     
- KendraIndex stringArn 
- The ARN of the Amazon Kendra index.
- KendraIndex stringArn 
- The ARN of the Amazon Kendra index.
- kendraIndex StringArn 
- The ARN of the Amazon Kendra index.
- kendraIndex stringArn 
- The ARN of the Amazon Kendra index.
- kendra_index_ strarn 
- The ARN of the Amazon Kendra index.
- kendraIndex StringArn 
- The ARN of the Amazon Kendra index.
KnowledgeBaseQueryEngineType    
KnowledgeBaseQueryGenerationColumn    
- Description string
- Inclusion
KnowledgeBase Inclusion Type 
- Name string
- description String
- inclusion
KnowledgeBase Inclusion Type 
- name String
- description string
- inclusion
KnowledgeBase Inclusion Type 
- name string
- description String
- inclusion "INCLUDE" | "EXCLUDE"
- name String
KnowledgeBaseQueryGenerationConfiguration    
- ExecutionTimeout intSeconds 
- The time after which query generation will time out.
- GenerationContext Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Context 
- Specifies configurations for context to use during query generation.
- ExecutionTimeout intSeconds 
- The time after which query generation will time out.
- GenerationContext KnowledgeBase Query Generation Context 
- Specifies configurations for context to use during query generation.
- executionTimeout IntegerSeconds 
- The time after which query generation will time out.
- generationContext KnowledgeBase Query Generation Context 
- Specifies configurations for context to use during query generation.
- executionTimeout numberSeconds 
- The time after which query generation will time out.
- generationContext 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.
- executionTimeout NumberSeconds 
- The time after which query generation will time out.
- generationContext Property Map
- Specifies configurations for context to use during query generation.
KnowledgeBaseQueryGenerationContext    
- CuratedQueries 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.
- CuratedQueries []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
[]KnowledgeBase Query Generation Table 
- An array of objects, each of which defines information about a table in the database.
- curatedQueries 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<KnowledgeBase Query Generation Table> 
- An array of objects, each of which defines information about a table in the database.
- curatedQueries 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
KnowledgeBase 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[KnowledgeBase Query Generation Table] 
- 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    
KnowledgeBaseRedshiftConfiguration   
- QueryEngine Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Configuration 
- Specifies configurations for an Amazon Redshift query engine.
- StorageConfigurations List<Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Storage Configuration> 
- Specifies configurations for Amazon Redshift database storage.
- QueryGeneration Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Query Generation Configuration 
- Specifies configurations for generating queries.
- QueryEngine KnowledgeConfiguration Base Redshift Query Engine Configuration 
- Specifies configurations for an Amazon Redshift query engine.
- StorageConfigurations []KnowledgeBase Redshift Query Engine Storage Configuration 
- Specifies configurations for Amazon Redshift database storage.
- QueryGeneration KnowledgeConfiguration Base Query Generation Configuration 
- Specifies configurations for generating queries.
- queryEngine KnowledgeConfiguration Base Redshift Query Engine Configuration 
- Specifies configurations for an Amazon Redshift query engine.
- storageConfigurations List<KnowledgeBase Redshift Query Engine Storage Configuration> 
- Specifies configurations for Amazon Redshift database storage.
- queryGeneration KnowledgeConfiguration Base Query Generation Configuration 
- Specifies configurations for generating queries.
- queryEngine KnowledgeConfiguration Base Redshift Query Engine Configuration 
- Specifies configurations for an Amazon Redshift query engine.
- storageConfigurations KnowledgeBase Redshift Query Engine Storage Configuration[] 
- Specifies configurations for Amazon Redshift database storage.
- queryGeneration KnowledgeConfiguration Base Query Generation Configuration 
- Specifies configurations for generating queries.
- query_engine_ Knowledgeconfiguration Base Redshift Query Engine Configuration 
- Specifies configurations for an Amazon Redshift query engine.
- storage_configurations Sequence[KnowledgeBase Redshift Query Engine Storage Configuration] 
- Specifies configurations for Amazon Redshift database storage.
- query_generation_ Knowledgeconfiguration Base Query Generation Configuration 
- Specifies configurations for generating queries.
- queryEngine Property MapConfiguration 
- Specifies configurations for an Amazon Redshift query engine.
- storageConfigurations List<Property Map>
- Specifies configurations for Amazon Redshift database storage.
- queryGeneration Property MapConfiguration 
- Specifies configurations for generating queries.
KnowledgeBaseRedshiftProvisionedAuthConfiguration     
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Provisioned Auth Type 
- The type of authentication to use.
- DatabaseUser string
- Redshift database user
- UsernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- Type
KnowledgeBase Redshift Provisioned Auth Type 
- The type of authentication to use.
- DatabaseUser string
- Redshift database user
- UsernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
KnowledgeBase Redshift Provisioned Auth Type 
- The type of authentication to use.
- databaseUser String
- Redshift database user
- usernamePassword StringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
KnowledgeBase Redshift Provisioned Auth Type 
- The type of authentication to use.
- databaseUser string
- Redshift database user
- usernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
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 "IAM" | "USERNAME_PASSWORD" | "USERNAME"
- The type of authentication to use.
- databaseUser String
- Redshift database user
- usernamePassword StringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
KnowledgeBaseRedshiftProvisionedAuthType     
KnowledgeBaseRedshiftProvisionedConfiguration    
- AuthConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Provisioned Auth Configuration 
- Specifies configurations for authentication to Amazon Redshift.
- ClusterIdentifier string
- The ID of the Amazon Redshift cluster.
- AuthConfiguration KnowledgeBase Redshift Provisioned Auth Configuration 
- Specifies configurations for authentication to Amazon Redshift.
- ClusterIdentifier string
- The ID of the Amazon Redshift cluster.
- authConfiguration KnowledgeBase Redshift Provisioned Auth Configuration 
- Specifies configurations for authentication to Amazon Redshift.
- clusterIdentifier String
- The ID of the Amazon Redshift cluster.
- authConfiguration KnowledgeBase Redshift Provisioned Auth Configuration 
- Specifies configurations for authentication to Amazon Redshift.
- clusterIdentifier string
- The ID of the Amazon Redshift cluster.
- auth_configuration KnowledgeBase Redshift Provisioned Auth Configuration 
- Specifies configurations for authentication to Amazon Redshift.
- cluster_identifier str
- The ID of the Amazon Redshift cluster.
- authConfiguration Property Map
- Specifies configurations for authentication to Amazon Redshift.
- clusterIdentifier String
- The ID of the Amazon Redshift cluster.
KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration         
- TableNames List<string>
- TableNames []string
- tableNames List<String>
- tableNames string[]
- table_names Sequence[str]
- tableNames List<String>
KnowledgeBaseRedshiftQueryEngineConfiguration     
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Query Engine Type 
- The type of query engine.
- ProvisionedConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Provisioned Configuration 
- Specifies configurations for a provisioned Amazon Redshift query engine.
- ServerlessConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Serverless Configuration 
- Specifies configurations for a serverless Amazon Redshift query engine.
- Type
KnowledgeBase Redshift Query Engine Type 
- The type of query engine.
- ProvisionedConfiguration KnowledgeBase Redshift Provisioned Configuration 
- Specifies configurations for a provisioned Amazon Redshift query engine.
- ServerlessConfiguration KnowledgeBase Redshift Serverless Configuration 
- Specifies configurations for a serverless Amazon Redshift query engine.
- type
KnowledgeBase Redshift Query Engine Type 
- The type of query engine.
- provisionedConfiguration KnowledgeBase Redshift Provisioned Configuration 
- Specifies configurations for a provisioned Amazon Redshift query engine.
- serverlessConfiguration KnowledgeBase Redshift Serverless Configuration 
- Specifies configurations for a serverless Amazon Redshift query engine.
- type
KnowledgeBase Redshift Query Engine Type 
- The type of query engine.
- provisionedConfiguration KnowledgeBase Redshift Provisioned Configuration 
- Specifies configurations for a provisioned Amazon Redshift query engine.
- serverlessConfiguration KnowledgeBase Redshift Serverless Configuration 
- Specifies configurations for a serverless Amazon Redshift query engine.
- type
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 "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       
- DatabaseName string
- DatabaseName string
- databaseName String
- databaseName string
- database_name str
- databaseName String
KnowledgeBaseRedshiftQueryEngineStorageConfiguration      
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Query Engine Storage Type 
- AwsData Pulumi.Catalog Configuration Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Aws Data Catalog Storage Configuration 
- RedshiftConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Query Engine Redshift Storage Configuration 
KnowledgeBaseRedshiftQueryEngineStorageType      
KnowledgeBaseRedshiftQueryEngineType     
KnowledgeBaseRedshiftServerlessAuthConfiguration     
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Redshift Serverless Auth Type 
- The type of authentication to use.
- UsernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- Type
KnowledgeBase Redshift Serverless Auth Type 
- The type of authentication to use.
- UsernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
KnowledgeBase Redshift Serverless Auth Type 
- The type of authentication to use.
- usernamePassword StringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
KnowledgeBase Redshift Serverless Auth Type 
- The type of authentication to use.
- usernamePassword stringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
- type
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 "IAM" | "USERNAME_PASSWORD"
- The type of authentication to use.
- usernamePassword StringSecret Arn 
- The ARN of an Secrets Manager secret for authentication.
KnowledgeBaseRedshiftServerlessAuthType     
KnowledgeBaseRedshiftServerlessConfiguration    
- AuthConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Serverless Auth Configuration 
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- WorkgroupArn string
- The ARN of the Amazon Redshift workgroup.
- AuthConfiguration KnowledgeBase Redshift Serverless Auth Configuration 
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- WorkgroupArn string
- The ARN of the Amazon Redshift workgroup.
- authConfiguration KnowledgeBase Redshift Serverless Auth Configuration 
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroupArn String
- The ARN of the Amazon Redshift workgroup.
- authConfiguration KnowledgeBase Redshift Serverless Auth Configuration 
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroupArn string
- The ARN of the Amazon Redshift workgroup.
- auth_configuration KnowledgeBase Redshift Serverless Auth Configuration 
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroup_arn str
- The ARN of the Amazon Redshift workgroup.
- authConfiguration Property Map
- Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
- workgroupArn String
- The ARN of the Amazon Redshift workgroup.
KnowledgeBaseS3Location  
- Uri string
- The location's URI
- Uri string
- The location's URI
- uri String
- The location's URI
- uri string
- The location's URI
- uri str
- The location's URI
- uri String
- The location's URI
KnowledgeBaseSqlKnowledgeBaseConfiguration     
- Type
Pulumi.Aws Native. Bedrock. Knowledge Base Query Engine Type 
- The type of SQL database to connect to the knowledge base.
- RedshiftConfiguration Pulumi.Aws Native. Bedrock. Inputs. Knowledge Base Redshift Configuration 
- Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- Type
KnowledgeBase Query Engine Type 
- The type of SQL database to connect to the knowledge base.
- RedshiftConfiguration KnowledgeBase Redshift Configuration 
- Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
KnowledgeBase Query Engine Type 
- The type of SQL database to connect to the knowledge base.
- redshiftConfiguration KnowledgeBase Redshift Configuration 
- Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
KnowledgeBase Query Engine Type 
- The type of SQL database to connect to the knowledge base.
- redshiftConfiguration KnowledgeBase Redshift Configuration 
- Specifies configurations for a knowledge base connected to an Amazon Redshift database.
- type
KnowledgeBase 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 "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  
KnowledgeBaseSupplementalDataStorageConfiguration     
KnowledgeBaseSupplementalDataStorageLocation     
KnowledgeBaseSupplementalDataStorageLocationType      
KnowledgeBaseType  
KnowledgeBaseVectorKnowledgeBaseConfiguration     
- EmbeddingModel stringArn 
- The ARN of the model used to create vector embeddings for the knowledge base.
- EmbeddingModel Pulumi.Configuration Aws Native. Bedrock. Inputs. Knowledge Base Embedding Model Configuration 
- The embeddings model configuration details for the vector model used in Knowledge Base.
- SupplementalData 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 .
- EmbeddingModel stringArn 
- The ARN of the model used to create vector embeddings for the knowledge base.
- EmbeddingModel KnowledgeConfiguration Base Embedding Model Configuration 
- The embeddings model configuration details for the vector model used in Knowledge Base.
- SupplementalData 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 .
- embeddingModel StringArn 
- The ARN of the model used to create vector embeddings for the knowledge base.
- embeddingModel KnowledgeConfiguration Base Embedding Model Configuration 
- The embeddings model configuration details for the vector model used in Knowledge Base.
- supplementalData 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 .
- embeddingModel stringArn 
- The ARN of the model used to create vector embeddings for the knowledge base.
- embeddingModel KnowledgeConfiguration Base Embedding Model Configuration 
- The embeddings model configuration details for the vector model used in Knowledge Base.
- supplementalData 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_ strarn 
- 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 .
- embeddingModel StringArn 
- The ARN of the model used to create vector embeddings for the knowledge base.
- embeddingModel Property MapConfiguration 
- The embeddings model configuration details for the vector model used in Knowledge Base.
- supplementalData 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.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi