Package software.amazon.awscdk.services.quicksight

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.quicksight.CfnKnowledgeBase

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IKnowledgeBaseRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:09.412Z")
@Stability(Stable)
public class CfnKnowledgeBase
extends CfnResource
implements IInspectable, IKnowledgeBaseRef, ITaggableV2

Definition of AWS::QuickSight::KnowledgeBase Resource Type.

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;
 CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase")
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnKnowledgeBase.AccessControlConfigurationProperty	Example:
static interface	CfnKnowledgeBase.AudioExtractionConfigurationProperty	Example:
static final class	CfnKnowledgeBase.Builder	A fluent builder for CfnKnowledgeBase.
static interface	CfnKnowledgeBase.ImageExtractionConfigurationProperty	Example:
static interface	CfnKnowledgeBase.KbTemplateConfigurationProperty	Example:
static interface	CfnKnowledgeBase.KnowledgeBaseConfigurationProperty	Example:
static interface	CfnKnowledgeBase.MediaExtractionConfigurationProperty	Example:
static interface	CfnKnowledgeBase.ResourcePermissionProperty	Permission for the resource.
static interface	CfnKnowledgeBase.VideoExtractionConfigurationProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.quicksight.IKnowledgeBaseRef

IKnowledgeBaseRef.Jsii$Default, IKnowledgeBaseRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef)
	CfnKnowledgeBase(software.constructs.Construct scope, String id, CfnKnowledgeBaseProps props)	Create a new AWS::QuickSight::KnowledgeBase.

Method Summary

Modifier and Type	Method	Description
static String	arnForKnowledgeBase(IKnowledgeBaseRef resource)
Object	getAccessControlConfiguration()	Returns union: either IResolvable or CfnKnowledgeBase.AccessControlConfigurationProperty
String	getAttrCreatedAt()
IResolvable	getAttrDocumentCount()
String	getAttrKnowledgeBaseArn()
IResolvable	getAttrKnowledgeBaseSizeBytes()
String	getAttrPrimaryOwnerUsername()
String	getAttrStatus()
String	getAttrType()
String	getAttrUpdatedAt()
String	getAwsAccountId()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getDataSourceArn()
String	getDescription()
Object	getIsEmailNotificationOptedForIngestionFailures()	Returns union: either Boolean or IResolvable
Object	getKnowledgeBaseConfiguration()	Returns union: either IResolvable or CfnKnowledgeBase.KnowledgeBaseConfigurationProperty
String	getKnowledgeBaseId()
KnowledgeBaseReference	getKnowledgeBaseRef()	A reference to a KnowledgeBase resource.
Object	getMediaExtractionConfiguration()	Returns union: either IResolvable or CfnKnowledgeBase.MediaExtractionConfigurationProperty
String	getName()
Object	getPermissions()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnKnowledgeBase.ResourcePermissionProperty>
String	getPrimaryOwnerArn()
List<CfnTag>	getTags()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnKnowledgeBase(Object x)	Checks whether the given object is a CfnKnowledgeBase.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessControlConfiguration(IResolvable value)
void	setAccessControlConfiguration(CfnKnowledgeBase.AccessControlConfigurationProperty value)
void	setAwsAccountId(String value)
void	setDataSourceArn(String value)
void	setDescription(String value)
void	setIsEmailNotificationOptedForIngestionFailures(Boolean value)
void	setIsEmailNotificationOptedForIngestionFailures(IResolvable value)
void	setKnowledgeBaseConfiguration(IResolvable value)
void	setKnowledgeBaseConfiguration(CfnKnowledgeBase.KnowledgeBaseConfigurationProperty value)
void	setKnowledgeBaseId(String value)
void	setMediaExtractionConfiguration(IResolvable value)
void	setMediaExtractionConfiguration(CfnKnowledgeBase.MediaExtractionConfigurationProperty value)
void	setName(String value)
void	setPermissions(List<Object> value)
void	setPermissions(IResolvable value)
void	setPrimaryOwnerArn(String value)
void	setTags(List<CfnTag> value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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::QuickSight::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.

isCfnKnowledgeBase

@Stability(Stable)
@NotNull
public static Boolean isCfnKnowledgeBase(@NotNull
 Object x)

Checks whether the given object is a CfnKnowledgeBase.

Parameters:

x - 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.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

getAttrDocumentCount

@Stability(Stable)
@NotNull
public IResolvable getAttrDocumentCount()

getAttrKnowledgeBaseArn

@Stability(Stable)
@NotNull
public String getAttrKnowledgeBaseArn()

getAttrKnowledgeBaseSizeBytes

@Stability(Stable)
@NotNull
public IResolvable getAttrKnowledgeBaseSizeBytes()

getAttrPrimaryOwnerUsername

@Stability(Stable)
@NotNull
public String getAttrPrimaryOwnerUsername()

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

getAttrType

@Stability(Stable)
@NotNull
public String getAttrType()

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getKnowledgeBaseRef

@Stability(Stable)
@NotNull
public KnowledgeBaseReference getKnowledgeBaseRef()

A reference to a KnowledgeBase resource.

Specified by:

getKnowledgeBaseRef in interface IKnowledgeBaseRef

getAwsAccountId

@Stability(Stable)
@NotNull
public String getAwsAccountId()

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@NotNull
 String value)

getDataSourceArn

@Stability(Stable)
@NotNull
public String getDataSourceArn()

setDataSourceArn

@Stability(Stable)
public void setDataSourceArn(@NotNull
 String value)

getKnowledgeBaseConfiguration

@Stability(Stable)
@NotNull
public Object getKnowledgeBaseConfiguration()

Returns union: either IResolvable or CfnKnowledgeBase.KnowledgeBaseConfigurationProperty

setKnowledgeBaseConfiguration

@Stability(Stable)
public void setKnowledgeBaseConfiguration(@NotNull
 IResolvable value)

setKnowledgeBaseConfiguration

@Stability(Stable)
public void setKnowledgeBaseConfiguration(@NotNull
 CfnKnowledgeBase.KnowledgeBaseConfigurationProperty value)

getKnowledgeBaseId

@Stability(Stable)
@NotNull
public String getKnowledgeBaseId()

setKnowledgeBaseId

@Stability(Stable)
public void setKnowledgeBaseId(@NotNull
 String value)

getName

@Stability(Stable)
@NotNull
public String getName()

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

getAccessControlConfiguration

@Stability(Stable)
@Nullable
public Object getAccessControlConfiguration()

Returns union: either IResolvable or CfnKnowledgeBase.AccessControlConfigurationProperty

setAccessControlConfiguration

@Stability(Stable)
public void setAccessControlConfiguration(@Nullable
 IResolvable value)

setAccessControlConfiguration

@Stability(Stable)
public void setAccessControlConfiguration(@Nullable
 CfnKnowledgeBase.AccessControlConfigurationProperty value)

getDescription

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

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

getIsEmailNotificationOptedForIngestionFailures

@Stability(Stable)
@Nullable
public Object getIsEmailNotificationOptedForIngestionFailures()

Returns union: either Boolean or IResolvable

setIsEmailNotificationOptedForIngestionFailures

@Stability(Stable)
public void setIsEmailNotificationOptedForIngestionFailures(@Nullable
 Boolean value)

setIsEmailNotificationOptedForIngestionFailures

@Stability(Stable)
public void setIsEmailNotificationOptedForIngestionFailures(@Nullable
 IResolvable value)

getMediaExtractionConfiguration

@Stability(Stable)
@Nullable
public Object getMediaExtractionConfiguration()

Returns union: either IResolvable or CfnKnowledgeBase.MediaExtractionConfigurationProperty

setMediaExtractionConfiguration

@Stability(Stable)
public void setMediaExtractionConfiguration(@Nullable
 IResolvable value)

setMediaExtractionConfiguration

@Stability(Stable)
public void setMediaExtractionConfiguration(@Nullable
 CfnKnowledgeBase.MediaExtractionConfigurationProperty value)

getPermissions

@Stability(Stable)
@Nullable
public Object getPermissions()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnKnowledgeBase.ResourcePermissionProperty>

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 IResolvable value)

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 List<Object> value)

getPrimaryOwnerArn

@Stability(Stable)
@Nullable
public String getPrimaryOwnerArn()

setPrimaryOwnerArn

@Stability(Stable)
public void setPrimaryOwnerArn(@Nullable
 String value)

getTags

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)