AWS Cloud Control v1.26.0, Mar 12 25

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.wisdom.KnowledgeBase

Explore with Pulumi AI

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

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

Create KnowledgeBase Resource

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

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_type: Optional[KnowledgeBaseType] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  rendering_configuration: Optional[KnowledgeBaseRenderingConfigurationArgs] = None,
                  server_side_encryption_configuration: Optional[KnowledgeBaseServerSideEncryptionConfigurationArgs] = None,
                  source_configuration: Optional[Union[KnowledgeBaseSourceConfiguration0PropertiesArgs, KnowledgeBaseSourceConfiguration1PropertiesArgs]] = None,
                  tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None,
                  vector_ingestion_configuration: Optional[KnowledgeBaseVectorIngestionConfigurationArgs] = 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:wisdom:KnowledgeBase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KnowledgeBaseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args KnowledgeBaseArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KnowledgeBaseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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:

KnowledgeBaseType Pulumi.AwsNative.Wisdom.KnowledgeBaseType: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
Description string: The description.
Name string: The name of the knowledge base.
RenderingConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseRenderingConfiguration: Information about how to render the content.
ServerSideEncryptionConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseServerSideEncryptionConfiguration: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
SourceConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseSourceConfiguration0Properties | Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseSourceConfiguration1Properties: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>: The tags used to organize, track, or control access for this resource.
VectorIngestionConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseVectorIngestionConfiguration: Contains details about how to ingest the documents in a data source.

KnowledgeBaseType KnowledgeBaseType: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
Description string: The description.
Name string: The name of the knowledge base.
RenderingConfiguration KnowledgeBaseRenderingConfigurationArgs: Information about how to render the content.
ServerSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfigurationArgs: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
SourceConfiguration KnowledgeBaseSourceConfiguration0PropertiesArgs | KnowledgeBaseSourceConfiguration1PropertiesArgs: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
Tags CreateOnlyTagArgs: The tags used to organize, track, or control access for this resource.
VectorIngestionConfiguration KnowledgeBaseVectorIngestionConfigurationArgs: Contains details about how to ingest the documents in a data source.

knowledgeBaseType KnowledgeBaseType: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
description String: The description.
name String: The name of the knowledge base.
renderingConfiguration KnowledgeBaseRenderingConfiguration: Information about how to render the content.
serverSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfiguration: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
sourceConfiguration KnowledgeBaseSourceConfiguration0Properties | KnowledgeBaseSourceConfiguration1Properties: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
tags List<CreateOnlyTag>: The tags used to organize, track, or control access for this resource.
vectorIngestionConfiguration KnowledgeBaseVectorIngestionConfiguration: Contains details about how to ingest the documents in a data source.

knowledgeBaseType KnowledgeBaseType: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
description string: The description.
name string: The name of the knowledge base.
renderingConfiguration KnowledgeBaseRenderingConfiguration: Information about how to render the content.
serverSideEncryptionConfiguration KnowledgeBaseServerSideEncryptionConfiguration: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
sourceConfiguration KnowledgeBaseSourceConfiguration0Properties | KnowledgeBaseSourceConfiguration1Properties: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
tags CreateOnlyTag[]: The tags used to organize, track, or control access for this resource.
vectorIngestionConfiguration KnowledgeBaseVectorIngestionConfiguration: Contains details about how to ingest the documents in a data source.

knowledge_base_type KnowledgeBaseType: The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
description str: The description.
name str: The name of the knowledge base.
rendering_configuration KnowledgeBaseRenderingConfigurationArgs: Information about how to render the content.
server_side_encryption_configuration KnowledgeBaseServerSideEncryptionConfigurationArgs: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
source_configuration KnowledgeBaseSourceConfiguration0PropertiesArgs | KnowledgeBaseSourceConfiguration1PropertiesArgs: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
tags Sequence[CreateOnlyTagArgs]: The tags used to organize, track, or control access for this resource.
vector_ingestion_configuration KnowledgeBaseVectorIngestionConfigurationArgs: Contains details about how to ingest the documents in a data source.

knowledgeBaseType "EXTERNAL" | "CUSTOM" | "MESSAGE_TEMPLATES" | "MANAGED": The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
description String: The description.
name String: The name of the knowledge base.
renderingConfiguration Property Map: Information about how to render the content.
serverSideEncryptionConfiguration Property Map: This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
sourceConfiguration Property Map | Property Map: The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
tags List<Property Map>: The tags used to organize, track, or control access for this resource.
vectorIngestionConfiguration Property Map: Contains details about how to ingest the documents in a data source.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
KnowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId string: The ID of the knowledge base.

Id string: The provider-assigned unique ID for this managed resource.
KnowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId string: The ID of the knowledge base.

id String: The provider-assigned unique ID for this managed resource.
knowledgeBaseArn String: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId String: The ID of the knowledge base.

id string: The provider-assigned unique ID for this managed resource.
knowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId string: The ID of the knowledge base.

id str: The provider-assigned unique ID for this managed resource.
knowledge_base_arn str: The Amazon Resource Name (ARN) of the knowledge base.
knowledge_base_id str: The ID of the knowledge base.

id String: The provider-assigned unique ID for this managed resource.
knowledgeBaseArn String: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId String: The ID of the knowledge base.

Supporting Types

CreateOnlyTag
, CreateOnlyTagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

KnowledgeBaseAppIntegrationsConfiguration
, KnowledgeBaseAppIntegrationsConfigurationArgs

AppIntegrationArn string
ObjectFields List<string>

AppIntegrationArn string
ObjectFields []string

appIntegrationArn String
objectFields List<String>

appIntegrationArn string
objectFields string[]

app_integration_arn str
object_fields Sequence[str]

appIntegrationArn String
objectFields List<String>

KnowledgeBaseBedrockFoundationModelConfiguration
, KnowledgeBaseBedrockFoundationModelConfigurationArgs

ModelArn string: The model ARN of the Bedrock foundation model.
ParsingPrompt Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties: The parsing prompt of the Bedrock foundation model configuration.

ModelArn string: The model ARN of the Bedrock foundation model.
ParsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties: The parsing prompt of the Bedrock foundation model configuration.

modelArn String: The model ARN of the Bedrock foundation model.
parsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties: The parsing prompt of the Bedrock foundation model configuration.

modelArn string: The model ARN of the Bedrock foundation model.
parsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties: The parsing prompt of the Bedrock foundation model configuration.

model_arn str: The model ARN of the Bedrock foundation model.
parsing_prompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties: The parsing prompt of the Bedrock foundation model configuration.

modelArn String: The model ARN of the Bedrock foundation model.
parsingPrompt Property Map: The parsing prompt of the Bedrock foundation model configuration.

KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
, KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptPropertiesArgs

ParsingPromptText string

ParsingPromptText string

parsingPromptText String

parsingPromptText string

parsing_prompt_text str

parsingPromptText String

KnowledgeBaseFixedSizeChunkingConfiguration
, KnowledgeBaseFixedSizeChunkingConfigurationArgs

MaxTokens double: The maximum number of tokens to include in a chunk.
OverlapPercentage double: The percentage of overlap between adjacent chunks of a data source.

MaxTokens float64: The maximum number of tokens to include in a chunk.
OverlapPercentage float64: The percentage of overlap between adjacent chunks of a data source.

maxTokens Double: The maximum number of tokens to include in a chunk.
overlapPercentage Double: The percentage of overlap between adjacent chunks of a data source.

maxTokens number: The maximum number of tokens to include in a chunk.
overlapPercentage number: The percentage of overlap between adjacent chunks of a data source.

max_tokens float: The maximum number of tokens to include in a chunk.
overlap_percentage float: The percentage of overlap between adjacent chunks of a data source.

maxTokens Number: The maximum number of tokens to include in a chunk.
overlapPercentage Number: The percentage of overlap between adjacent chunks of a data source.

KnowledgeBaseHierarchicalChunkingConfiguration
, KnowledgeBaseHierarchicalChunkingConfigurationArgs

LevelConfigurations List<Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseHierarchicalChunkingLevelConfiguration>: Token settings for each layer.
OverlapTokens double: The number of tokens to repeat across chunks in the same layer.

LevelConfigurations []KnowledgeBaseHierarchicalChunkingLevelConfiguration: Token settings for each layer.
OverlapTokens float64: The number of tokens to repeat across chunks in the same layer.

levelConfigurations List<KnowledgeBaseHierarchicalChunkingLevelConfiguration>: Token settings for each layer.
overlapTokens Double: The number of tokens to repeat across chunks in the same layer.

levelConfigurations KnowledgeBaseHierarchicalChunkingLevelConfiguration[]: Token settings for each layer.
overlapTokens number: The number of tokens to repeat across chunks in the same layer.

level_configurations Sequence[KnowledgeBaseHierarchicalChunkingLevelConfiguration]: Token settings for each layer.
overlap_tokens float: The number of tokens to repeat across chunks in the same layer.

levelConfigurations List<Property Map>: Token settings for each layer.
overlapTokens Number: The number of tokens to repeat across chunks in the same layer.

KnowledgeBaseHierarchicalChunkingLevelConfiguration
, KnowledgeBaseHierarchicalChunkingLevelConfigurationArgs

MaxTokens double: The maximum number of tokens that a chunk can contain in this layer.

MaxTokens float64: The maximum number of tokens that a chunk can contain in this layer.

maxTokens Double: The maximum number of tokens that a chunk can contain in this layer.

maxTokens number: The maximum number of tokens that a chunk can contain in this layer.

max_tokens float: The maximum number of tokens that a chunk can contain in this layer.

maxTokens Number: The maximum number of tokens that a chunk can contain in this layer.

KnowledgeBaseManagedSourceConfigurationProperties
, KnowledgeBaseManagedSourceConfigurationPropertiesArgs

WebCrawlerConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseWebCrawlerConfiguration

WebCrawlerConfiguration KnowledgeBaseWebCrawlerConfiguration

webCrawlerConfiguration KnowledgeBaseWebCrawlerConfiguration

webCrawlerConfiguration KnowledgeBaseWebCrawlerConfiguration

web_crawler_configuration KnowledgeBaseWebCrawlerConfiguration

webCrawlerConfiguration Property Map

KnowledgeBaseRenderingConfiguration
, KnowledgeBaseRenderingConfigurationArgs

TemplateUri string

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
Zendesk: id , title , updated_at , or draft