CfnKnowledgeBaseProps

class aws_cdk.aws_quicksight.CfnKnowledgeBaseProps(*, aws_account_id, data_source_arn, knowledge_base_configuration, knowledge_base_id, name, access_control_configuration=None, description=None, is_email_notification_opted_for_ingestion_failures=None, media_extraction_configuration=None, permissions=None, primary_owner_arn=None, tags=None)

Bases: object

Properties for defining a CfnKnowledgeBase.

Parameters:

aws_account_id (str)
data_source_arn (str)
knowledge_base_configuration (Union[IResolvable, KnowledgeBaseConfigurationProperty, Dict[str, Any]])
knowledge_base_id (str)
name (str)
access_control_configuration (Union[IResolvable, AccessControlConfigurationProperty, Dict[str, Any], None])
description (Optional[str])
is_email_notification_opted_for_ingestion_failures (Union[bool, IResolvable, None])
media_extraction_configuration (Union[IResolvable, MediaExtractionConfigurationProperty, Dict[str, Any], None])
permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None])
primary_owner_arn (Optional[str])
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

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"
    )]
)