pulumi-aws-kotlin/com.pulumi.aws.kendra.kotlin/Faq

Faq

class Faq : KotlinCustomResource

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());
    }
}

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());
    }
}

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());
    }
}

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-8012925589

Properties

arn

val arn: Output<String>

ARN of the FAQ.

createdAt

val createdAt: Output<String>

The Unix datetime that the FAQ was created.

description

val description: Output<String>?

The description for a FAQ.

errorMessage

val errorMessage: Output<String>

When the Status field value is FAILED, this contains a message that explains why.

faqId

val faqId: Output<String>

The identifier of the FAQ.

fileFormat

val fileFormat: Output<String>?

The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.

val id: Output<String>

indexId

val indexId: Output<String>

The identifier of the index for a FAQ.

languageCode

val languageCode: Output<String>

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.

name

val name: Output<String>

The name that should be associated with the FAQ.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

roleArn

val roleArn: Output<String>

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.

s3Path

val s3Path: Output<FaqS3Path>

The S3 location of the FAQ input data. Detailed below. The s3_path configuration block supports the following arguments:

status

val status: Output<String>

The status of the FAQ. It is ready to use when the status is ACTIVE.