Package software.amazon.awscdk.services.kendra

Interface CfnQuerySuggestionsBlockListProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQuerySuggestionsBlockListProps.Jsii$Proxy

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

Properties for defining a CfnQuerySuggestionsBlockList.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CfnQuerySuggestionsBlockListProps cfnQuerySuggestionsBlockListProps = CfnQuerySuggestionsBlockListProps.builder()
         .indexId("indexId")
         .name("name")
         .roleArn("roleArn")
         .sourceS3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         // the properties below are optional
         .description("description")
         .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	CfnQuerySuggestionsBlockListProps.Builder	A builder for CfnQuerySuggestionsBlockListProps
static final class	CfnQuerySuggestionsBlockListProps.Jsii$Proxy	An implementation for CfnQuerySuggestionsBlockListProps

Method Summary

Modifier and Type	Method	Description
static CfnQuerySuggestionsBlockListProps.Builder	builder()
default String	getDescription()	A description for the block list.
String	getIndexId()	The identifier of the index for the block list.
String	getName()	The name of the block list.
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.
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

getIndexId

@Stability(Stable)
@NotNull
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)
@NotNull
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)
@NotNull
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)
@NotNull
Object getSourceS3Path()

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

Returns union: either IResolvable or CfnQuerySuggestionsBlockList.S3PathProperty

See Also:

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

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

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 CfnQuerySuggestionsBlockListProps.Builder builder()

Returns:

a CfnQuerySuggestionsBlockListProps.Builder of CfnQuerySuggestionsBlockListProps