CfnKnowledgeBasePropsMixin

class aws_cdk.cfn_property_mixins.aws_quicksight.CfnKnowledgeBasePropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-knowledgebase.html
CloudformationResource:: AWS::QuickSight::KnowledgeBase
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy
# template: Any

cfn_knowledge_base_props_mixin = quicksight.CfnKnowledgeBasePropsMixin(quicksight.CfnKnowledgeBaseMixinProps(
    access_control_configuration=quicksight.CfnKnowledgeBasePropsMixin.AccessControlConfigurationProperty(
        is_acl_enabled=False
    ),
    aws_account_id="awsAccountId",
    data_source_arn="dataSourceArn",
    description="description",
    is_email_notification_opted_for_ingestion_failures=False,
    knowledge_base_configuration=quicksight.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty(
        template_configuration=quicksight.CfnKnowledgeBasePropsMixin.KbTemplateConfigurationProperty(
            template=template
        )
    ),
    knowledge_base_id="knowledgeBaseId",
    media_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.MediaExtractionConfigurationProperty(
        audio_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.AudioExtractionConfigurationProperty(
            audio_extraction_status="audioExtractionStatus"
        ),
        image_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.ImageExtractionConfigurationProperty(
            image_extraction_status="imageExtractionStatus"
        ),
        video_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.VideoExtractionConfigurationProperty(
            video_extraction_status="videoExtractionStatus",
            video_extraction_type="videoExtractionType"
        )
    ),
    name="name",
    permissions=[quicksight.CfnKnowledgeBasePropsMixin.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal",
        resource="resource"
    )],
    primary_owner_arn="primaryOwnerArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::QuickSight::KnowledgeBase.

Parameters:

props (Union[CfnKnowledgeBaseMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessControlConfiguration', 'awsAccountId', 'dataSourceArn', 'description', 'isEmailNotificationOptedForIngestionFailures', 'knowledgeBaseConfiguration', 'knowledgeBaseId', 'mediaExtractionConfiguration', 'name', 'permissions', 'primaryOwnerArn', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AccessControlConfigurationProperty

class CfnKnowledgeBasePropsMixin.AccessControlConfigurationProperty(*, is_acl_enabled=None)

Bases: object

Parameters:: is_acl_enabled (Union[bool, IResolvable, None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-accesscontrolconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

access_control_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.AccessControlConfigurationProperty(
    is_acl_enabled=False
)

Attributes

is_acl_enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-accesscontrolconfiguration.html#cfn-quicksight-knowledgebase-accesscontrolconfiguration-isaclenabled

Type:: see

AudioExtractionConfigurationProperty

class CfnKnowledgeBasePropsMixin.AudioExtractionConfigurationProperty(*, audio_extraction_status=None)

Bases: object

Parameters:: audio_extraction_status (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-audioextractionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

audio_extraction_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.AudioExtractionConfigurationProperty(
    audio_extraction_status="audioExtractionStatus"
)

Attributes

audio_extraction_status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-audioextractionconfiguration.html#cfn-quicksight-knowledgebase-audioextractionconfiguration-audioextractionstatus

Type:: see

ImageExtractionConfigurationProperty

class CfnKnowledgeBasePropsMixin.ImageExtractionConfigurationProperty(*, image_extraction_status=None)

Bases: object

Parameters:: image_extraction_status (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-imageextractionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

image_extraction_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.ImageExtractionConfigurationProperty(
    image_extraction_status="imageExtractionStatus"
)

Attributes

image_extraction_status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-imageextractionconfiguration.html#cfn-quicksight-knowledgebase-imageextractionconfiguration-imageextractionstatus

Type:: see

KbTemplateConfigurationProperty

class CfnKnowledgeBasePropsMixin.KbTemplateConfigurationProperty(*, template=None)

Bases: object

Parameters:: template (Any)
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-kbtemplateconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

# template: Any

kb_template_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.KbTemplateConfigurationProperty(
    template=template
)

Attributes

template

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-kbtemplateconfiguration.html#cfn-quicksight-knowledgebase-kbtemplateconfiguration-template

Type:: see

KnowledgeBaseConfigurationProperty

class CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty(*, template_configuration=None)

Bases: object

Parameters:: template_configuration (Union[IResolvable, KbTemplateConfigurationProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-knowledgebaseconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

# template: Any

knowledge_base_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty(
    template_configuration=quicksight.CfnKnowledgeBasePropsMixin.KbTemplateConfigurationProperty(
        template=template
    )
)

Attributes

template_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-knowledgebaseconfiguration.html#cfn-quicksight-knowledgebase-knowledgebaseconfiguration-templateconfiguration

Type:: see

MediaExtractionConfigurationProperty

class CfnKnowledgeBasePropsMixin.MediaExtractionConfigurationProperty(*, audio_extraction_configuration=None, image_extraction_configuration=None, video_extraction_configuration=None)

Bases: object

Parameters:

audio_extraction_configuration (Union[IResolvable, AudioExtractionConfigurationProperty, Dict[str, Any], None])
image_extraction_configuration (Union[IResolvable, ImageExtractionConfigurationProperty, Dict[str, Any], None])
video_extraction_configuration (Union[IResolvable, VideoExtractionConfigurationProperty, Dict[str, Any], None])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

media_extraction_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.MediaExtractionConfigurationProperty(
    audio_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.AudioExtractionConfigurationProperty(
        audio_extraction_status="audioExtractionStatus"
    ),
    image_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.ImageExtractionConfigurationProperty(
        image_extraction_status="imageExtractionStatus"
    ),
    video_extraction_configuration=quicksight.CfnKnowledgeBasePropsMixin.VideoExtractionConfigurationProperty(
        video_extraction_status="videoExtractionStatus",
        video_extraction_type="videoExtractionType"
    )
)

Attributes

audio_extraction_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-mediaextractionconfiguration.html#cfn-quicksight-knowledgebase-mediaextractionconfiguration-audioextractionconfiguration

Type:: see

image_extraction_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-mediaextractionconfiguration.html#cfn-quicksight-knowledgebase-mediaextractionconfiguration-imageextractionconfiguration

Type:: see

video_extraction_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-mediaextractionconfiguration.html#cfn-quicksight-knowledgebase-mediaextractionconfiguration-videoextractionconfiguration

Type:: see

ResourcePermissionProperty

class CfnKnowledgeBasePropsMixin.ResourcePermissionProperty(*, actions=None, principal=None, resource=None)

Bases: object

Parameters:

actions (Optional[Sequence[str]])
principal (Optional[str]) – This can be one of the following: The ARN of an Amazon Quick user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon Quick user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
resource (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

resource_permission_property = quicksight.CfnKnowledgeBasePropsMixin.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal",
    resource="resource"
)

Attributes

actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-resourcepermission.html#cfn-quicksight-knowledgebase-resourcepermission-actions

Type:: see

principal

This can be one of the following:

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-resourcepermission.html#cfn-quicksight-knowledgebase-resourcepermission-principal

resource

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

Type:: see

VideoExtractionConfigurationProperty

class CfnKnowledgeBasePropsMixin.VideoExtractionConfigurationProperty(*, video_extraction_status=None, video_extraction_type=None)

Bases: object

Parameters:

video_extraction_status (Optional[str])
video_extraction_type (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_quicksight as quicksight

video_extraction_configuration_property = quicksight.CfnKnowledgeBasePropsMixin.VideoExtractionConfigurationProperty(
    video_extraction_status="videoExtractionStatus",
    video_extraction_type="videoExtractionType"
)

Attributes

video_extraction_status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-videoextractionconfiguration.html#cfn-quicksight-knowledgebase-videoextractionconfiguration-videoextractionstatus

Type:: see

video_extraction_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-knowledgebase-videoextractionconfiguration.html#cfn-quicksight-knowledgebase-videoextractionconfiguration-videoextractiontype

Type:: see