Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. getKnowledgeBase

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getKnowledgeBase

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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>
Copy
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]
Copy
func LookupKnowledgeBase(ctx *Context, args *LookupKnowledgeBaseArgs, opts ...InvokeOption) (*LookupKnowledgeBaseResult, error)
func LookupKnowledgeBaseOutput(ctx *Context, args *LookupKnowledgeBaseOutputArgs, opts ...InvokeOption) LookupKnowledgeBaseResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
public static Output<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:bedrock:getKnowledgeBase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

KnowledgeBaseId This property is required. string
The unique identifier of the knowledge base.
KnowledgeBaseId This property is required. string
The unique identifier of the knowledge base.
knowledgeBaseId This property is required. String
The unique identifier of the knowledge base.
knowledgeBaseId This property is required. string
The unique identifier of the knowledge base.
knowledge_base_id This property is required. str
The unique identifier of the knowledge base.
knowledgeBaseId This property is required. String
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.
KnowledgeBaseArn string
The ARN of the knowledge base.
KnowledgeBaseConfiguration Pulumi.AwsNative.Bedrock.Outputs.KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
KnowledgeBaseId string
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.AwsNative.Bedrock.KnowledgeBaseStatus
The status of the knowledge base.
Tags Dictionary<string, string>
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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.
KnowledgeBaseArn string
The ARN of the knowledge base.
KnowledgeBaseConfiguration KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
KnowledgeBaseId string
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 KnowledgeBaseStatus
The status of the knowledge base.
Tags map[string]string
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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.
knowledgeBaseArn String
The ARN of the knowledge base.
knowledgeBaseConfiguration KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
knowledgeBaseId String
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 KnowledgeBaseStatus
The status of the knowledge base.
tags Map<String,String>
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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.
knowledgeBaseArn string
The ARN of the knowledge base.
knowledgeBaseConfiguration KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
knowledgeBaseId string
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 KnowledgeBaseStatus
The status of the knowledge base.
tags {[key: string]: string}
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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_arn str
The ARN of the knowledge base.
knowledge_base_configuration KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
knowledge_base_id str
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 KnowledgeBaseStatus
The status of the knowledge base.
tags Mapping[str, str]
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

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.
knowledgeBaseArn String
The ARN of the knowledge base.
knowledgeBaseConfiguration Property Map
Contains details about the embeddings configuration of the knowledge base.
knowledgeBaseId String
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.
tags 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.
EmbeddingDataType Pulumi.AwsNative.Bedrock.KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
Dimensions int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
EmbeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions Integer
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions number
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embedding_data_type KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType
The data type for the vectors when using a model to convert text into vector embeddings.
dimensions Number
The dimensions details for the vector configuration used on the Bedrock embeddings model.
embeddingDataType "FLOAT32" | "BINARY"
The data type for the vectors when using a model to convert text into vector embeddings.

KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType

KnowledgeBaseConfiguration

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

KnowledgeBaseCuratedQuery

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

KnowledgeBaseEmbeddingModelConfiguration

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

KnowledgeBaseInclusionType

KnowledgeBaseKendraKnowledgeBaseConfiguration

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

KnowledgeBaseQueryEngineType

KnowledgeBaseQueryGenerationColumn

KnowledgeBaseQueryGenerationConfiguration

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

KnowledgeBaseQueryGenerationContext

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

KnowledgeBaseQueryGenerationTable

KnowledgeBaseRedshiftConfiguration

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

KnowledgeBaseRedshiftProvisionedAuthConfiguration

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

KnowledgeBaseRedshiftProvisionedAuthType

KnowledgeBaseRedshiftProvisionedConfiguration

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

KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration

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

KnowledgeBaseRedshiftQueryEngineConfiguration

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

KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration

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

KnowledgeBaseRedshiftQueryEngineStorageConfiguration

KnowledgeBaseRedshiftQueryEngineStorageType

KnowledgeBaseRedshiftQueryEngineType

KnowledgeBaseRedshiftServerlessAuthConfiguration

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

KnowledgeBaseRedshiftServerlessAuthType

KnowledgeBaseRedshiftServerlessConfiguration

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

KnowledgeBaseS3Location

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

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

KnowledgeBaseStatus

KnowledgeBaseSupplementalDataStorageConfiguration

KnowledgeBaseSupplementalDataStorageLocation

KnowledgeBaseSupplementalDataStorageLocationType

KnowledgeBaseType

KnowledgeBaseVectorKnowledgeBaseConfiguration

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

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native