AWS CDK

2.264.0

interface CfnKnowledgeBaseProps

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnKnowledgeBaseProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnKnowledgeBaseProps`
Java	`software.amazon.awscdk.services.quicksight.CfnKnowledgeBaseProps`
Python	`aws_cdk.aws_quicksight.CfnKnowledgeBaseProps`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnKnowledgeBaseProps`

Properties for defining a CfnKnowledgeBase.

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

Example

// 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',
  }],
};

Properties

Name	Type	Description
awsAccountId	`string`
dataSourceArn	`string`
knowledgeBaseConfiguration	`IResolvable` `\|` `KnowledgeBaseConfigurationProperty`
knowledgeBaseId	`string`
name	`string`
accessControlConfiguration?	`IResolvable` `\|` `AccessControlConfigurationProperty`
description?	`string`
isEmailNotificationOptedForIngestionFailures?	`boolean \|` `IResolvable`
mediaExtractionConfiguration?	`IResolvable` `\|` `MediaExtractionConfigurationProperty`
permissions?	`IResolvable` `\| (IResolvable` `\|` `ResourcePermissionProperty)[]`
primaryOwnerArn?	`string`
tags?	`CfnTag[]`

awsAccountId

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-awsaccountid

dataSourceArn

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-datasourcearn

knowledgeBaseConfiguration

Type: IResolvable | KnowledgeBaseConfigurationProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-knowledgebaseconfiguration

knowledgeBaseId

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-knowledgebaseid

name

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-name

accessControlConfiguration?

Type: IResolvable | AccessControlConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-accesscontrolconfiguration

description?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-description

isEmailNotificationOptedForIngestionFailures?

Type: boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-isemailnotificationoptedforingestionfailures

mediaExtractionConfiguration?

Type: IResolvable | MediaExtractionConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-mediaextractionconfiguration

permissions?

Type: IResolvable | (IResolvable | ResourcePermissionProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-permissions

primaryOwnerArn?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-primaryownerarn

tags?

Type: CfnTag[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html#cfn-quicksight-knowledgebase-tags

← Previous Next →