Package software.amazon.awscdk.services.wisdom

Interface CfnKnowledgeBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:10.918Z")
@Stability(Stable)
public interface CfnKnowledgeBaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnKnowledgeBase.

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.*;
 CfnKnowledgeBaseProps cfnKnowledgeBaseProps = CfnKnowledgeBaseProps.builder()
         .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())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBaseProps.Builder	A builder for CfnKnowledgeBaseProps
static final class	CfnKnowledgeBaseProps.Jsii$Proxy	An implementation for CfnKnowledgeBaseProps

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBaseProps.Builder	builder()
default String	getDescription()	The description.
String	getKnowledgeBaseType()	The type of knowledge base.
String	getName()	The name of the knowledge base.
default Object	getRenderingConfiguration()	Information about how to render the content.
default 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.
default Object	getSourceConfiguration()	The source of the knowledge base content.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKnowledgeBaseType

@Stability(Stable)
@NotNull
String getKnowledgeBaseType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-knowledgebasetype

getName

@Stability(Stable)
@NotNull
String getName()

The name of the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-description

getRenderingConfiguration

@Stability(Stable)
@Nullable
default Object getRenderingConfiguration()

Information about how to render the content.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-renderingconfiguration

getServerSideEncryptionConfiguration

@Stability(Stable)
@Nullable
default 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.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-serversideencryptionconfiguration

getSourceConfiguration

@Stability(Stable)
@Nullable
default Object getSourceConfiguration()

The source of the knowledge base content.

Only set this argument for EXTERNAL or Managed knowledge bases.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-sourceconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags used to organize, track, or control access for this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-tags

builder

@Stability(Stable)
static CfnKnowledgeBaseProps.Builder builder()

Returns:

a CfnKnowledgeBaseProps.Builder of CfnKnowledgeBaseProps