@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
165 lines (164 loc) • 5.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use the `awsKendraIndexBlockList` resource to manage an AWS Kendra block list used for query suggestions for an index.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.kendra.QuerySuggestionsBlockList("example", {
* indexId: exampleAwsKendraIndex.id,
* name: "Example",
* roleArn: exampleAwsIamRole.arn,
* sourceS3Path: {
* bucket: exampleAwsS3Bucket.id,
* key: "example/suggestions.txt",
* },
* tags: {
* Name: "Example Kendra Index",
* },
* });
* ```
*
* ## 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
* ```
*/
export declare class QuerySuggestionsBlockList extends pulumi.CustomResource {
/**
* Get an existing QuerySuggestionsBlockList 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 Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QuerySuggestionsBlockListState, opts?: pulumi.CustomResourceOptions): QuerySuggestionsBlockList;
/**
* Returns true if the given object is an instance of QuerySuggestionsBlockList. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is QuerySuggestionsBlockList;
/**
* ARN of the block list.
*/
readonly arn: pulumi.Output<string>;
readonly description: pulumi.Output<string | undefined>;
/**
* Identifier of the index for a block list.
*/
readonly indexId: pulumi.Output<string>;
/**
* Name for the block list.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the block list.
*/
readonly querySuggestionsBlockListId: pulumi.Output<string>;
readonly region: pulumi.Output<string>;
/**
* IAM (Identity and Access Management) role used to access the block list text file in S3.
*/
readonly roleArn: pulumi.Output<string>;
/**
* S3 path where your block list text file is located. See details below.
*/
readonly sourceS3Path: pulumi.Output<outputs.kendra.QuerySuggestionsBlockListSourceS3Path>;
readonly status: pulumi.Output<string>;
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider's defaultTags configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a QuerySuggestionsBlockList resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: QuerySuggestionsBlockListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering QuerySuggestionsBlockList resources.
*/
export interface QuerySuggestionsBlockListState {
/**
* ARN of the block list.
*/
arn?: pulumi.Input<string>;
description?: pulumi.Input<string>;
/**
* Identifier of the index for a block list.
*/
indexId?: pulumi.Input<string>;
/**
* Name for the block list.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the block list.
*/
querySuggestionsBlockListId?: pulumi.Input<string>;
region?: pulumi.Input<string>;
/**
* IAM (Identity and Access Management) role used to access the block list text file in S3.
*/
roleArn?: pulumi.Input<string>;
/**
* S3 path where your block list text file is located. See details below.
*/
sourceS3Path?: pulumi.Input<inputs.kendra.QuerySuggestionsBlockListSourceS3Path>;
status?: pulumi.Input<string>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider's defaultTags configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a QuerySuggestionsBlockList resource.
*/
export interface QuerySuggestionsBlockListArgs {
description?: pulumi.Input<string>;
/**
* Identifier of the index for a block list.
*/
indexId: pulumi.Input<string>;
/**
* Name for the block list.
*/
name?: pulumi.Input<string>;
region?: pulumi.Input<string>;
/**
* IAM (Identity and Access Management) role used to access the block list text file in S3.
*/
roleArn: pulumi.Input<string>;
/**
* S3 path where your block list text file is located. See details below.
*/
sourceS3Path: pulumi.Input<inputs.kendra.QuerySuggestionsBlockListSourceS3Path>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}