CfnQuerySuggestionsBlockListPropsMixin

class aws_cdk.cfn_property_mixins.aws_kendra.CfnQuerySuggestionsBlockListPropsMixin(props, *, strategy=None)

Bases: Mixin

A block list used for query suggestions for an Amazon Kendra index.

A block list contains words or phrases that should not appear as query suggestions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html
CloudformationResource:: AWS::Kendra::QuerySuggestionsBlockList
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_kendra as kendra
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

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

Create a mixin to apply properties to AWS::Kendra::QuerySuggestionsBlockList.

Parameters:

props (Union[CfnQuerySuggestionsBlockListMixinProps, 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 = ['description', 'indexId', 'name', 'roleArn', 'sourceS3Path', '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.

S3PathProperty

class CfnQuerySuggestionsBlockListPropsMixin.S3PathProperty(*, bucket=None, key=None)

Bases: object

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

Parameters:

bucket (Optional[str]) – The name of the S3 bucket that contains the file.
key (Optional[str]) – The name of the file.

See:

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

s3_path_property = kendra.CfnQuerySuggestionsBlockListPropsMixin.S3PathProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

The name of the S3 bucket that contains the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-querysuggestionsblocklist-s3path.html#cfn-kendra-querysuggestionsblocklist-s3path-bucket

key

The name of the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-querysuggestionsblocklist-s3path.html#cfn-kendra-querysuggestionsblocklist-s3path-key