com.pulumi.aws.kendra.QuerySuggestionsBlockList Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.kendra;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.kendra.QuerySuggestionsBlockListArgs;
import com.pulumi.aws.kendra.inputs.QuerySuggestionsBlockListState;
import com.pulumi.aws.kendra.outputs.QuerySuggestionsBlockListSourceS3Path;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Use the `aws_kendra_index_block_list` resource to manage an AWS Kendra block list used for query suggestions for an index.
*
* ## Example Usage
*
* ### Basic Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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.List;
* import java.util.ArrayList;
* 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()
* .indexId(exampleAwsKendraIndex.id())
* .name("Example")
* .roleArn(exampleAwsIamRole.arn())
* .sourceS3Path(QuerySuggestionsBlockListSourceS3PathArgs.builder()
* .bucket(exampleAwsS3Bucket.id())
* .key("example/suggestions.txt")
* .build())
* .tags(Map.of("Name", "Example Kendra Index"))
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import the `aws_kendra_query_suggestions_block_list` 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
* ```
*
*/
@ResourceType(type="aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList")
public class QuerySuggestionsBlockList extends com.pulumi.resources.CustomResource {
/**
* ARN of the block list.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return ARN of the block list.
*
*/
public Output arn() {
return this.arn;
}
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Identifier of the index for a block list.
*
*/
@Export(name="indexId", refs={String.class}, tree="[0]")
private Output indexId;
/**
* @return Identifier of the index for a block list.
*
*/
public Output indexId() {
return this.indexId;
}
/**
* Name for the block list.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name for the block list.
*
*/
public Output name() {
return this.name;
}
/**
* Unique identifier of the block list.
*
*/
@Export(name="querySuggestionsBlockListId", refs={String.class}, tree="[0]")
private Output querySuggestionsBlockListId;
/**
* @return Unique identifier of the block list.
*
*/
public Output querySuggestionsBlockListId() {
return this.querySuggestionsBlockListId;
}
/**
* IAM (Identity and Access Management) role used to access the block list text file in S3.
*
*/
@Export(name="roleArn", refs={String.class}, tree="[0]")
private Output roleArn;
/**
* @return IAM (Identity and Access Management) role used to access the block list text file in S3.
*
*/
public Output roleArn() {
return this.roleArn;
}
/**
* S3 path where your block list text file is located. See details below.
*
*/
@Export(name="sourceS3Path", refs={QuerySuggestionsBlockListSourceS3Path.class}, tree="[0]")
private Output sourceS3Path;
/**
* @return S3 path where your block list text file is located. See details below.
*
*/
public Output sourceS3Path() {
return this.sourceS3Path;
}
@Export(name="status", refs={String.class}, tree="[0]")
private Output status;
public Output status() {
return this.status;
}
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* Map of tags assigned to the resource, including those inherited from the provider's default_tags configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return Map of tags assigned to the resource, including those inherited from the provider's default_tags configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public QuerySuggestionsBlockList(java.lang.String name) {
this(name, QuerySuggestionsBlockListArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public QuerySuggestionsBlockList(java.lang.String name, QuerySuggestionsBlockListArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public QuerySuggestionsBlockList(java.lang.String name, QuerySuggestionsBlockListArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private QuerySuggestionsBlockList(java.lang.String name, Output id, @Nullable QuerySuggestionsBlockListState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList", name, state, makeResourceOptions(options, id), false);
}
private static QuerySuggestionsBlockListArgs makeArgs(QuerySuggestionsBlockListArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? QuerySuggestionsBlockListArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static QuerySuggestionsBlockList get(java.lang.String name, Output id, @Nullable QuerySuggestionsBlockListState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new QuerySuggestionsBlockList(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy