QuerySuggestionsBlockList class
Use the aws.kendra.QuerySuggestionsBlockList resource to manage an AWS Kendra block list used for query suggestions for an index.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.QuerySuggestionsBlockList("example", {
sourceS3Path: {
bucket: exampleAwsS3Bucket.id,
key: "example/suggestions.txt",
},
indexId: exampleAwsKendraIndex.id,
name: "Example",
roleArn: exampleAwsIamRole.arn,
tags: {
Name: "Example Kendra Index",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.QuerySuggestionsBlockList("example",
source_s3_path={
"bucket": example_aws_s3_bucket["id"],
"key": "example/suggestions.txt",
},
index_id=example_aws_kendra_index["id"],
name="Example",
role_arn=example_aws_iam_role["arn"],
tags={
"Name": "Example Kendra Index",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.QuerySuggestionsBlockList("example", new()
{
SourceS3Path = new Aws.Kendra.Inputs.QuerySuggestionsBlockListSourceS3PathArgs
{
Bucket = exampleAwsS3Bucket.Id,
Key = "example/suggestions.txt",
},
IndexId = exampleAwsKendraIndex.Id,
Name = "Example",
RoleArn = exampleAwsIamRole.Arn,
Tags =
{
{ "Name", "Example Kendra Index" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewQuerySuggestionsBlockList(ctx, "example", &kendra.QuerySuggestionsBlockListArgs{
SourceS3Path: &kendra.QuerySuggestionsBlockListSourceS3PathArgs{
Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
Key: pulumi.String("example/suggestions.txt"),
},
IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
Name: pulumi.String("Example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Kendra Index"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kendra_querysuggestionsblocklist" "example" {
source_s3_path = {
bucket = exampleAwsS3Bucket.id
key = "example/suggestions.txt"
}
index_id = exampleAwsKendraIndex.id
name = "Example"
role_arn = exampleAwsIamRole.arn
tags = {
"Name" = "Example Kendra Index"
}
}
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());
}
}
resources:
example:
type: aws:kendra:QuerySuggestionsBlockList
properties:
sourceS3Path:
bucket: ${exampleAwsS3Bucket.id}
key: example/suggestions.txt
indexId: ${exampleAwsKendraIndex.id}
name: Example
roleArn: ${exampleAwsIamRole.arn}
tags:
Name: Example Kendra Index
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:
$ pulumi import aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList example blocklist-123456780/idx-8012925589
Constructors
- QuerySuggestionsBlockList(String name, {QuerySuggestionsBlockListArgs? args, CustomResourceOptions? options})
-
Creates a new QuerySuggestionsBlockList.
nameThe Pulumi resource name.argsArguments used to configure this QuerySuggestionsBlockList. The set of arguments for QuerySuggestionsBlockList.optionsResource options controlling this resource's behavior. - QuerySuggestionsBlockList.reference(String urn)
- Creates a typed reference to an existing QuerySuggestionsBlockList resource.
Properties
-
arn
↔ Output<
String> -
ARN of the block list.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
indexId
↔ Output<
String> -
Identifier of the index for a block list.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name for the block list.
latefinal
-
querySuggestionsBlockListId
↔ Output<
String> -
Unique identifier of the block list.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
roleArn
↔ Output<
String> -
IAM (Identity and Access Management) role used to access the block list text file in S3.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceS3Path
↔ Output<
QuerySuggestionsBlockListSourceS3Path> -
S3 path where your block list text file is located. See details below.
latefinal
-
status
↔ Output<
String> -
latefinal
-
latefinal
-
Map of tags assigned to the resource, including those inherited from the provider's defaultTags configuration block.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {QuerySuggestionsBlockListState? state, CustomResourceOptions? options}) → QuerySuggestionsBlockList -
Gets an existing QuerySuggestionsBlockList resource's state with the given
nameandid.