Package software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wisdom.CfnKnowledgeBase
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IKnowledgeBaseRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:32.058Z") @Stability(Stable) public class CfnKnowledgeBase extends CfnResource implements IInspectable, IKnowledgeBaseRef, ITaggable
Specifies a knowledge base.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase")
         .knowledgeBaseType("knowledgeBaseType")
         .name("name")
         // the properties below are optional
         .description("description")
         .renderingConfiguration(RenderingConfigurationProperty.builder()
                 .templateUri("templateUri")
                 .build())
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .appIntegrations(AppIntegrationsConfigurationProperty.builder()
                         .appIntegrationArn("appIntegrationArn")
                         // the properties below are optional
                         .objectFields(List.of("objectFields"))
                         .build())
                 .managedSourceConfiguration(ManagedSourceConfigurationProperty.builder()
                         .webCrawlerConfiguration(WebCrawlerConfigurationProperty.builder()
                                 .urlConfiguration(UrlConfigurationProperty.builder()
                                         .seedUrls(List.of(SeedUrlProperty.builder()
                                                 .url("url")
                                                 .build()))
                                         .build())
                                 // the properties below are optional
                                 .crawlerLimits(CrawlerLimitsProperty.builder()
                                         .rateLimit(123)
                                         .build())
                                 .exclusionFilters(List.of("exclusionFilters"))
                                 .inclusionFilters(List.of("inclusionFilters"))
                                 .scope("scope")
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vectorIngestionConfiguration(VectorIngestionConfigurationProperty.builder()
                 .chunkingConfiguration(ChunkingConfigurationProperty.builder()
                         .chunkingStrategy("chunkingStrategy")
                         // the properties below are optional
                         .fixedSizeChunkingConfiguration(FixedSizeChunkingConfigurationProperty.builder()
                                 .maxTokens(123)
                                 .overlapPercentage(123)
                                 .build())
                         .hierarchicalChunkingConfiguration(HierarchicalChunkingConfigurationProperty.builder()
                                 .levelConfigurations(List.of(HierarchicalChunkingLevelConfigurationProperty.builder()
                                         .maxTokens(123)
                                         .build()))
                                 .overlapTokens(123)
                                 .build())
                         .semanticChunkingConfiguration(SemanticChunkingConfigurationProperty.builder()
                                 .breakpointPercentileThreshold(123)
                                 .bufferSize(123)
                                 .maxTokens(123)
                                 .build())
                         .build())
                 .parsingConfiguration(ParsingConfigurationProperty.builder()
                         .parsingStrategy("parsingStrategy")
                         // the properties below are optional
                         .bedrockFoundationModelConfiguration(BedrockFoundationModelConfigurationProperty.builder()
                                 .modelArn("modelArn")
                                 // the properties below are optional
                                 .parsingPrompt(ParsingPromptProperty.builder()
                                         .parsingPromptText("parsingPromptText")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnKnowledgeBase

      protected CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnKnowledgeBase

      protected CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnKnowledgeBase

      @Stability(Stable) public CfnKnowledgeBase(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnKnowledgeBaseProps props)
      Create a new AWS::Wisdom::KnowledgeBase.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForKnowledgeBase

      @Stability(Stable) @NotNull public static String arnForKnowledgeBase(@NotNull IKnowledgeBaseRef resource)
      Parameters:
      resource - This parameter is required.

    • fromKnowledgeBaseArn

      @Stability(Stable) @NotNull public static IKnowledgeBaseRef fromKnowledgeBaseArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IKnowledgeBaseRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromKnowledgeBaseId

      @Stability(Stable) @NotNull public static IKnowledgeBaseRef fromKnowledgeBaseId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String knowledgeBaseId)
      Creates a new IKnowledgeBaseRef from a knowledgeBaseId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      knowledgeBaseId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrKnowledgeBaseArn

      @Stability(Stable) @NotNull public String getAttrKnowledgeBaseArn()
      The Amazon Resource Name (ARN) of the knowledge base.

    • getAttrKnowledgeBaseId

      @Stability(Stable) @NotNull public String getAttrKnowledgeBaseId()
      The ID of the knowledge base.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getKnowledgeBaseRef

      @Stability(Stable) @NotNull public KnowledgeBaseReference getKnowledgeBaseRef()
      A reference to a KnowledgeBase resource.
      Specified by:
      getKnowledgeBaseRef in interface IKnowledgeBaseRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getKnowledgeBaseType

      @Stability(Stable) @NotNull public String getKnowledgeBaseType()
      The type of knowledge base.

    • setKnowledgeBaseType

      @Stability(Stable) public void setKnowledgeBaseType(@NotNull String value)
      The type of knowledge base.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the knowledge base.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the knowledge base.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description.

    • getRenderingConfiguration

      @Stability(Stable) @Nullable public Object getRenderingConfiguration()
      Information about how to render the content.

      Returns union: either IResolvable or CfnKnowledgeBase.RenderingConfigurationProperty

    • setRenderingConfiguration

      @Stability(Stable) public void setRenderingConfiguration(@Nullable IResolvable value)
      Information about how to render the content.

    • setRenderingConfiguration

      @Stability(Stable) public void setRenderingConfiguration(@Nullable CfnKnowledgeBase.RenderingConfigurationProperty value)
      Information about how to render the content.

    • getServerSideEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getServerSideEncryptionConfiguration()
      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.

      Returns union: either IResolvable or CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty

    • setServerSideEncryptionConfiguration

      @Stability(Stable) public void setServerSideEncryptionConfiguration(@Nullable IResolvable value)
      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.

    • setServerSideEncryptionConfiguration

      @Stability(Stable) public void setServerSideEncryptionConfiguration(@Nullable CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value)
      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.

    • getSourceConfiguration

      @Stability(Stable) @Nullable public Object getSourceConfiguration()
      The source of the knowledge base content.

      Returns union: either IResolvable or CfnKnowledgeBase.SourceConfigurationProperty

    • setSourceConfiguration

      @Stability(Stable) public void setSourceConfiguration(@Nullable IResolvable value)
      The source of the knowledge base content.

    • setSourceConfiguration

      @Stability(Stable) public void setSourceConfiguration(@Nullable CfnKnowledgeBase.SourceConfigurationProperty value)
      The source of the knowledge base content.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags used to organize, track, or control access for this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.

    • getVectorIngestionConfiguration

      @Stability(Stable) @Nullable public Object getVectorIngestionConfiguration()
      Contains details about how to ingest the documents in a data source.

      Returns union: either IResolvable or CfnKnowledgeBase.VectorIngestionConfigurationProperty

    • setVectorIngestionConfiguration

      @Stability(Stable) public void setVectorIngestionConfiguration(@Nullable IResolvable value)
      Contains details about how to ingest the documents in a data source.

    • setVectorIngestionConfiguration

      @Stability(Stable) public void setVectorIngestionConfiguration(@Nullable CfnKnowledgeBase.VectorIngestionConfigurationProperty value)
      Contains details about how to ingest the documents in a data source.