Interface CfnKnowledgeBaseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnKnowledgeBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
date="2026-08-10T14:51:09.415Z")
@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.quicksight.*;
Object template;
CfnKnowledgeBaseProps cfnKnowledgeBaseProps = CfnKnowledgeBaseProps.builder()
.awsAccountId("awsAccountId")
.dataSourceArn("dataSourceArn")
.knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder()
.templateConfiguration(KbTemplateConfigurationProperty.builder()
.template(template)
.build())
.build())
.knowledgeBaseId("knowledgeBaseId")
.name("name")
// the properties below are optional
.accessControlConfiguration(AccessControlConfigurationProperty.builder()
.isAclEnabled(false)
.build())
.description("description")
.isEmailNotificationOptedForIngestionFailures(false)
.mediaExtractionConfiguration(MediaExtractionConfigurationProperty.builder()
.audioExtractionConfiguration(AudioExtractionConfigurationProperty.builder()
.audioExtractionStatus("audioExtractionStatus")
.build())
.imageExtractionConfiguration(ImageExtractionConfigurationProperty.builder()
.imageExtractionStatus("imageExtractionStatus")
.build())
.videoExtractionConfiguration(VideoExtractionConfigurationProperty.builder()
.videoExtractionStatus("videoExtractionStatus")
// the properties below are optional
.videoExtractionType("videoExtractionType")
.build())
.build())
.permissions(List.of(ResourcePermissionProperty.builder()
.actions(List.of("actions"))
.principal("principal")
// the properties below are optional
.resource("resource")
.build()))
.primaryOwnerArn("primaryOwnerArn")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnKnowledgeBasePropsstatic final classAn implementation forCfnKnowledgeBaseProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectReturns union: eitherIResolvableorCfnKnowledgeBase.AccessControlConfigurationPropertydefault Stringdefault ObjectReturns union: eitherBooleanorIResolvableReturns union: eitherIResolvableorCfnKnowledgeBase.KnowledgeBaseConfigurationPropertydefault ObjectReturns union: eitherIResolvableorCfnKnowledgeBase.MediaExtractionConfigurationPropertygetName()default ObjectReturns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnKnowledgeBase.ResourcePermissionProperty>default StringgetTags()Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAwsAccountId
- See Also:
-
getDataSourceArn
- See Also:
-
getKnowledgeBaseConfiguration
Returns union: eitherIResolvableorCfnKnowledgeBase.KnowledgeBaseConfigurationProperty- See Also:
-
getKnowledgeBaseId
- See Also:
-
getName
- See Also:
-
getAccessControlConfiguration
Returns union: eitherIResolvableorCfnKnowledgeBase.AccessControlConfigurationProperty- See Also:
-
getDescription
- See Also:
-
getIsEmailNotificationOptedForIngestionFailures
Returns union: eitherBooleanorIResolvable- See Also:
-
getMediaExtractionConfiguration
Returns union: eitherIResolvableorCfnKnowledgeBase.MediaExtractionConfigurationProperty- See Also:
-
getPermissions
Returns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnKnowledgeBase.ResourcePermissionProperty>- See Also:
-
getPrimaryOwnerArn
- See Also:
-
getTags
- See Also:
-
builder
- Returns:
- a
CfnKnowledgeBaseProps.BuilderofCfnKnowledgeBaseProps
-