Package com.pulumi.aws.kendra

Class QuerySuggestionsBlockList

  • public class QuerySuggestionsBlockList
extends com.pulumi.resources.CustomResource
    Use the `aws.kendra.QuerySuggestionsBlockList` resource to manage an AWS Kendra block list used for query suggestions for an index. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kendra.QuerySuggestionsBlockList;
 import com.pulumi.aws.kendra.QuerySuggestionsBlockListArgs;
 import com.pulumi.aws.kendra.inputs.QuerySuggestionsBlockListSourceS3PathArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new QuerySuggestionsBlockList("example", QuerySuggestionsBlockListArgs.builder()
             .sourceS3Path(QuerySuggestionsBlockListSourceS3PathArgs.builder()
                 .bucket(exampleAwsS3Bucket.id())
                 .key("example/suggestions.txt")
                 .build())
             .indexId(exampleAwsKendraIndex.id())
             .name("Example")
             .roleArn(exampleAwsIamRole.arn())
             .tags(Map.of("Name", "Example Kendra Index"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import the `aws.kendra.QuerySuggestionsBlockList` resource using the unique identifiers of the block list and index separated by a slash (`/`). For example: ```sh $ pulumi import aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList example blocklist-123456780/idx-8012925589 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static QuerySuggestionsBlockList get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, QuerySuggestionsBlockListState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> indexId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> querySuggestionsBlockListId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<QuerySuggestionsBlockListSourceS3Path> sourceS3Path()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • QuerySuggestionsBlockList

        public QuerySuggestionsBlockList​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • QuerySuggestionsBlockList

        public QuerySuggestionsBlockList​(java.lang.String name,
                                 QuerySuggestionsBlockListArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • QuerySuggestionsBlockList

        public QuerySuggestionsBlockList​(java.lang.String name,
                                 QuerySuggestionsBlockListArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the block list.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for a block list.

      • indexId

        public com.pulumi.core.Output<java.lang.String> indexId()
        Returns:
        Identifier of the index for a block list.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the block list.

      • querySuggestionsBlockListId

        public com.pulumi.core.Output<java.lang.String> querySuggestionsBlockListId()
        Returns:
        Unique identifier of the block list.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • roleArn

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        IAM (Identity and Access Management) role used to access the block list text file in S3.

      • sourceS3Path

        public com.pulumi.core.Output<QuerySuggestionsBlockListSourceS3Path> sourceS3Path()
        Returns:
        S3 path where your block list text file is located. See `sourceS3Path` Block for details. The following arguments are optional:

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current status of the block list.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider's defaultTags configuration block.

      • get

        public static QuerySuggestionsBlockList get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            QuerySuggestionsBlockListState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.