Package software.amazon.awscdk.services.kendra

Class CfnQuerySuggestionsBlockList

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kendra.CfnQuerySuggestionsBlockList
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IQuerySuggestionsBlockListRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:12.360Z") @Stability(Stable) public class CfnQuerySuggestionsBlockList extends CfnResource implements IInspectable, IQuerySuggestionsBlockListRef, ITaggableV2
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.

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.*;
 CfnQuerySuggestionsBlockList cfnQuerySuggestionsBlockList = CfnQuerySuggestionsBlockList.Builder.create(this, "MyCfnQuerySuggestionsBlockList")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQuerySuggestionsBlockList

      protected CfnQuerySuggestionsBlockList(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQuerySuggestionsBlockList

      protected CfnQuerySuggestionsBlockList(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQuerySuggestionsBlockList

      @Stability(Stable) public CfnQuerySuggestionsBlockList(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnQuerySuggestionsBlockListProps props)
      Create a new AWS::Kendra::QuerySuggestionsBlockList.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForQuerySuggestionsBlockList

      @Stability(Stable) @NotNull public static String arnForQuerySuggestionsBlockList(@NotNull IQuerySuggestionsBlockListRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnQuerySuggestionsBlockList

      @Stability(Stable) @NotNull public static Boolean isCfnQuerySuggestionsBlockList(@NotNull Object x)
      Checks whether the given object is a CfnQuerySuggestionsBlockList.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the query suggestions block list.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the block list.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getQuerySuggestionsBlockListRef

      @Stability(Stable) @NotNull public QuerySuggestionsBlockListReference getQuerySuggestionsBlockListRef()
      A reference to a QuerySuggestionsBlockList resource.
      Specified by:
      getQuerySuggestionsBlockListRef in interface IQuerySuggestionsBlockListRef

    • getIndexId

      @Stability(Stable) @NotNull public String getIndexId()
      The identifier of the index for the block list.

    • setIndexId

      @Stability(Stable) public void setIndexId(@NotNull String value)
      The identifier of the index for the block list.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the block list.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the block list.

    • getRoleArn

      @Stability(Stable) @NotNull public 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.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.

    • getSourceS3Path

      @Stability(Stable) @NotNull public Object getSourceS3Path()
      Information required to find a specific file in an Amazon S3 bucket.

      Returns union: either IResolvable or CfnQuerySuggestionsBlockList.S3PathProperty

    • setSourceS3Path

      @Stability(Stable) public void setSourceS3Path(@NotNull IResolvable value)
      Information required to find a specific file in an Amazon S3 bucket.

    • setSourceS3Path

      @Stability(Stable) public void setSourceS3Path(@NotNull CfnQuerySuggestionsBlockList.S3PathProperty value)
      Information required to find a specific file in an Amazon S3 bucket.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the block list.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the block list.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize the block list.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize the block list.