CfnQuerySuggestionsBlockListProps

class aws_cdk.aws_kendra.CfnQuerySuggestionsBlockListProps(*, index_id, name, role_arn, source_s3_path, description=None, tags=None)

Bases: object

Properties for defining a CfnQuerySuggestionsBlockList.

Parameters:

index_id (str) – The identifier of the index for the block list.
name (str) – The name of the block list.
role_arn (str) – The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
source_s3_path (Union[IResolvable, S3PathProperty, Dict[str, Any]]) – Information required to find a specific file in an Amazon S3 bucket.
description (Optional[str]) – A description for the block list.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs that identify or categorize the block list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.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_kendra as kendra

cfn_query_suggestions_block_list_props = kendra.CfnQuerySuggestionsBlockListProps(
    index_id="indexId",
    name="name",
    role_arn="roleArn",
    source_s3_path=kendra.CfnQuerySuggestionsBlockList.S3PathProperty(
        bucket="bucket",
        key="key"
    ),

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)