Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnQuerySuggestionsBlockListMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQuerySuggestionsBlockListMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:29.005Z")
@Stability(Stable)
public interface CfnQuerySuggestionsBlockListMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnQuerySuggestionsBlockListPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kendra.*;
 CfnQuerySuggestionsBlockListMixinProps cfnQuerySuggestionsBlockListMixinProps = CfnQuerySuggestionsBlockListMixinProps.builder()
         .description("description")
         .indexId("indexId")
         .name("name")
         .roleArn("roleArn")
         .sourceS3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQuerySuggestionsBlockListMixinProps.Builder	A builder for CfnQuerySuggestionsBlockListMixinProps
static final class	CfnQuerySuggestionsBlockListMixinProps.Jsii$Proxy	An implementation for CfnQuerySuggestionsBlockListMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnQuerySuggestionsBlockListMixinProps.Builder	builder()
default String	getDescription()	A description for the block list.
default String	getIndexId()	The identifier of the index for the block list.
default String	getName()	The name of the block list.
default String	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
default Object	getSourceS3Path()	Information required to find a specific file in an Amazon S3 bucket.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the block list.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the block list.

See Also:

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

getIndexId

@Stability(Stable)
@Nullable
default String getIndexId()

The identifier of the index for the block list.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the block list.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getSourceS3Path

@Stability(Stable)
@Nullable
default Object getSourceS3Path()

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

Returns union: either IResolvable or CfnQuerySuggestionsBlockListPropsMixin.S3PathProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs that identify or categorize the block list.

See Also:

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

builder

@Stability(Stable)
static CfnQuerySuggestionsBlockListMixinProps.Builder builder()

Returns:

a CfnQuerySuggestionsBlockListMixinProps.Builder of CfnQuerySuggestionsBlockListMixinProps