primaryOwnerArnoptionalstringprimary_owner_arnoptionalstrprimaryOwnerArnoptionalStringPrimaryOwnerArnoptionalstringPrimaryOwnerArnoptional*string#CfnKnowledgeBaseProps Struct
Properties for defining a CfnKnowledgeBase.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
declare const template: any;
const cfnKnowledgeBaseProps: quicksight.CfnKnowledgeBaseProps = {
awsAccountId: 'awsAccountId',
dataSourceArn: 'dataSourceArn',
knowledgeBaseConfiguration: {
templateConfiguration: {
template: template,
},
},
knowledgeBaseId: 'knowledgeBaseId',
name: 'name',
// the properties below are optional
accessControlConfiguration: {
isAclEnabled: false,
},
description: 'description',
isEmailNotificationOptedForIngestionFailures: false,
mediaExtractionConfiguration: {
audioExtractionConfiguration: {
audioExtractionStatus: 'audioExtractionStatus',
},
imageExtractionConfiguration: {
imageExtractionStatus: 'imageExtractionStatus',
},
videoExtractionConfiguration: {
videoExtractionStatus: 'videoExtractionStatus',
// the properties below are optional
videoExtractionType: 'videoExtractionType',
},
},
permissions: [{
actions: ['actions'],
principal: 'principal',
// the properties below are optional
resource: 'resource',
}],
primaryOwnerArn: 'primaryOwnerArn',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight
# template: Any
cfn_knowledge_base_props = quicksight.CfnKnowledgeBaseProps(
aws_account_id="awsAccountId",
data_source_arn="dataSourceArn",
knowledge_base_configuration=quicksight.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty(
template_configuration=quicksight.CfnKnowledgeBase.KbTemplateConfigurationProperty(
template=template
)
),
knowledge_base_id="knowledgeBaseId",
name="name",
# the properties below are optional
access_control_configuration=quicksight.CfnKnowledgeBase.AccessControlConfigurationProperty(
is_acl_enabled=False
),
description="description",
is_email_notification_opted_for_ingestion_failures=False,
media_extraction_configuration=quicksight.CfnKnowledgeBase.MediaExtractionConfigurationProperty(
audio_extraction_configuration=quicksight.CfnKnowledgeBase.AudioExtractionConfigurationProperty(
audio_extraction_status="audioExtractionStatus"
),
image_extraction_configuration=quicksight.CfnKnowledgeBase.ImageExtractionConfigurationProperty(
image_extraction_status="imageExtractionStatus"
),
video_extraction_configuration=quicksight.CfnKnowledgeBase.VideoExtractionConfigurationProperty(
video_extraction_status="videoExtractionStatus",
# the properties below are optional
video_extraction_type="videoExtractionType"
)
),
permissions=[quicksight.CfnKnowledgeBase.ResourcePermissionProperty(
actions=["actions"],
principal="principal",
# the properties below are optional
resource="resource"
)],
primary_owner_arn="primaryOwnerArn",
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var template;
var cfnKnowledgeBaseProps = new CfnKnowledgeBaseProps {
AwsAccountId = "awsAccountId",
DataSourceArn = "dataSourceArn",
KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
TemplateConfiguration = new KbTemplateConfigurationProperty {
Template = template
}
},
KnowledgeBaseId = "knowledgeBaseId",
Name = "name",
// the properties below are optional
AccessControlConfiguration = new AccessControlConfigurationProperty {
IsAclEnabled = false
},
Description = "description",
IsEmailNotificationOptedForIngestionFailures = false,
MediaExtractionConfiguration = new MediaExtractionConfigurationProperty {
AudioExtractionConfiguration = new AudioExtractionConfigurationProperty {
AudioExtractionStatus = "audioExtractionStatus"
},
ImageExtractionConfiguration = new ImageExtractionConfigurationProperty {
ImageExtractionStatus = "imageExtractionStatus"
},
VideoExtractionConfiguration = new VideoExtractionConfigurationProperty {
VideoExtractionStatus = "videoExtractionStatus",
// the properties below are optional
VideoExtractionType = "videoExtractionType"
}
},
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal",
// the properties below are optional
Resource = "resource"
} },
PrimaryOwnerArn = "primaryOwnerArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var template interface{}
cfnKnowledgeBaseProps := &CfnKnowledgeBaseProps{
AwsAccountId: jsii.String("awsAccountId"),
DataSourceArn: jsii.String("dataSourceArn"),
KnowledgeBaseConfiguration: &KnowledgeBaseConfigurationProperty{
TemplateConfiguration: &KbTemplateConfigurationProperty{
Template: template,
},
},
KnowledgeBaseId: jsii.String("knowledgeBaseId"),
Name: jsii.String("name"),
// the properties below are optional
AccessControlConfiguration: &AccessControlConfigurationProperty{
IsAclEnabled: jsii.Boolean(false),
},
Description: jsii.String("description"),
IsEmailNotificationOptedForIngestionFailures: jsii.Boolean(false),
MediaExtractionConfiguration: &MediaExtractionConfigurationProperty{
AudioExtractionConfiguration: &AudioExtractionConfigurationProperty{
AudioExtractionStatus: jsii.String("audioExtractionStatus"),
},
ImageExtractionConfiguration: &ImageExtractionConfigurationProperty{
ImageExtractionStatus: jsii.String("imageExtractionStatus"),
},
VideoExtractionConfiguration: &VideoExtractionConfigurationProperty{
VideoExtractionStatus: jsii.String("videoExtractionStatus"),
// the properties below are optional
VideoExtractionType: jsii.String("videoExtractionType"),
},
},
Permissions: []interface{}{
&ResourcePermissionProperty{
Actions: []*string{
jsii.String("actions"),
},
Principal: jsii.String("principal"),
// the properties below are optional
Resource: jsii.String("resource"),
},
},
PrimaryOwnerArn: jsii.String("primaryOwnerArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
accessControlConfigurationoptionalIResolvable | CfnKnowledgeBase.AccessControlConfigurationPropertyaccess_control_configurationoptionaltyping.Union[IResolvable, AccessControlConfigurationProperty]accessControlConfigurationoptionalIResolvableAccessControlConfigurationoptionalIResolvableAccessControlConfigurationoptionalinterface{}#dataSourceArnstringdata_source_arnstrdataSourceArnStringDataSourceArnstringDataSourceArn*stringrequired#descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#isEmailNotificationOptedForIngestionFailuresoptionalboolean | IResolvableis_email_notification_opted_for_ingestion_failuresoptionaltyping.Union[bool, IResolvable]isEmailNotificationOptedForIngestionFailuresoptionalBooleanIsEmailNotificationOptedForIngestionFailuresoptionalboolIsEmailNotificationOptedForIngestionFailuresoptionalinterface{}#knowledgeBaseConfigurationIResolvable | CfnKnowledgeBase.KnowledgeBaseConfigurationPropertyknowledge_base_configurationtyping.Union[IResolvable, KnowledgeBaseConfigurationProperty]knowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationinterface{}required#knowledgeBaseIdstringknowledge_base_idstrknowledgeBaseIdStringKnowledgeBaseIdstringKnowledgeBaseId*stringrequired#mediaExtractionConfigurationoptionalIResolvable | CfnKnowledgeBase.MediaExtractionConfigurationPropertymedia_extraction_configurationoptionaltyping.Union[IResolvable, MediaExtractionConfigurationProperty]mediaExtractionConfigurationoptionalIResolvableMediaExtractionConfigurationoptionalIResolvableMediaExtractionConfigurationoptionalinterface{}#permissionsoptionalIResolvable | IResolvable | CfnKnowledgeBase.ResourcePermissionProperty[]permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsoptionalIResolvablePermissionsoptionalIResolvablePermissionsoptionalinterface{}#