Faq
data class FaqArgs(val description: Output<String>? = null, val fileFormat: Output<String>? = null, val indexId: Output<String>? = null, val languageCode: Output<String>? = null, val name: Output<String>? = null, val roleArn: Output<String>? = null, val s3Path: Output<FaqS3PathArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<FaqArgs>
Resource for managing an AWS Kendra FAQ.
Example Usage
Basic
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
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 Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.tags(Map.of("Name", "Example Kendra Faq"))
.build());
}
}Content copied to clipboard
With File Format
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
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 Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.fileFormat("CSV")
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.build());
}
}Content copied to clipboard
With Language Code
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
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 Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.languageCode("en")
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.build());
}
}Content copied to clipboard
Import
aws_kendra_faq can be imported using the unique identifiers of the FAQ and index separated by a slash (/), e.g.,
$ pulumi import aws:kendra/faq:Faq example faq-123456780/idx-8012925589Content copied to clipboard
Constructors
Link copied to clipboard
constructor(description: Output<String>? = null, fileFormat: Output<String>? = null, indexId: Output<String>? = null, languageCode: Output<String>? = null, name: Output<String>? = null, roleArn: Output<String>? = null, s3Path: Output<FaqS3PathArgs>? = null, tags: Output<Map<String, String>>? = null)
Properties
Link copied to clipboard
The description for a FAQ.
Link copied to clipboard
The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
Link copied to clipboard
The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
Link copied to clipboard
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
Link copied to clipboard
The S3 location of the FAQ input data. Detailed below. The s3_path configuration block supports the following arguments: