CfnQuerySuggestionsBlockListMixinProps

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

Bases: object

Properties for CfnQuerySuggestionsBlockListPropsMixin.

Parameters:
  • description (Optional[str]) – A description for the block list.

  • index_id (Optional[str]) – The identifier of the index for the block list.

  • name (Optional[str]) – The name of the block list.

  • role_arn (Optional[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], None]) – Information required to find a specific file in an Amazon S3 bucket.

  • 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.cfn_property_mixins import aws_kendra as kendra

cfn_query_suggestions_block_list_mixin_props = kendra.CfnQuerySuggestionsBlockListMixinProps(
    description="description",
    index_id="indexId",
    name="name",
    role_arn="roleArn",
    source_s3_path=kendra.CfnQuerySuggestionsBlockListPropsMixin.S3PathProperty(
        bucket="bucket",
        key="key"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description for the block list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-description

index_id

The identifier of the index for the block list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-indexid

name

The name of the block list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-name

role_arn

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-rolearn

source_s3_path

Information required to find a specific file in an Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-sources3path

tags

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#cfn-kendra-querysuggestionsblocklist-tags