Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. kendra
  6. Faq
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.kendra.Faq

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an AWS Kendra FAQ.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kendra.Faq("example", {
    s3Path: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
    },
    indexId: exampleAwsKendraIndex.id,
    name: "Example",
    roleArn: exampleAwsIamRole.arn,
    tags: {
        Name: "Example Kendra Faq",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.kendra.Faq("example",
    s3_path={
        "bucket": example_aws_s3_bucket["id"],
        "key": example_aws_s3_object["key"],
    },
    index_id=example_aws_kendra_index["id"],
    name="Example",
    role_arn=example_aws_iam_role["arn"],
    tags={
        "Name": "Example Kendra Faq",
    })

    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.NewFaq(ctx, "example", &kendra.FaqArgs{
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
			IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
			Name:    pulumi.String("Example"),
			RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Kendra Faq"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kendra.Faq("example", new()
    {
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        RoleArn = exampleAwsIamRole.Arn,
        Tags = 
        {
            { "Name", "Example Kendra Faq" },
        },
    });

});

    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.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 Faq("example", FaqArgs.builder()
            .s3Path(FaqS3PathArgs.builder()
                .bucket(exampleAwsS3Bucket.get("id"))
                .key(exampleAwsS3Object.get("key"))
                .build())
            .indexId(exampleAwsKendraIndex.get("id"))
            .name("Example")
            .roleArn(exampleAwsIamRole.get("arn"))
            .tags(Map.of("Name", "Example Kendra Faq"))
            .build());

    }
}

    resources:
  example:
    type: aws:kendra:Faq
    properties:
      s3Path:
        bucket: ${exampleAwsS3Bucket.id}
        key: ${exampleAwsS3Object.key}
      indexId: ${exampleAwsKendraIndex.id}
      name: Example
      roleArn: ${exampleAwsIamRole.arn}
      tags:
        Name: Example Kendra Faq

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kendra_faq" "example" {
  lifecycle {
    create_before_destroy = true
  }
  s3_path {
    bucket = exampleAwsS3Bucket.id
    key    = exampleAwsS3Object.key
  }
  index_id = exampleAwsKendraIndex.id
  name     = "Example"
  role_arn = exampleAwsIamRole.arn
  tags = {
    "Name" = "Example Kendra Faq"
  }
}

    With File Format

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kendra.Faq("example", {
    s3Path: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
    },
    indexId: exampleAwsKendraIndex.id,
    name: "Example",
    fileFormat: "CSV",
    roleArn: exampleAwsIamRole.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.kendra.Faq("example",
    s3_path={
        "bucket": example_aws_s3_bucket["id"],
        "key": example_aws_s3_object["key"],
    },
    index_id=example_aws_kendra_index["id"],
    name="Example",
    file_format="CSV",
    role_arn=example_aws_iam_role["arn"])

    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.NewFaq(ctx, "example", &kendra.FaqArgs{
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
			IndexId:    pulumi.Any(exampleAwsKendraIndex.Id),
			Name:       pulumi.String("Example"),
			FileFormat: pulumi.String("CSV"),
			RoleArn:    pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kendra.Faq("example", new()
    {
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        FileFormat = "CSV",
        RoleArn = exampleAwsIamRole.Arn,
    });

});

    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.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 Faq("example", FaqArgs.builder()
            .s3Path(FaqS3PathArgs.builder()
                .bucket(exampleAwsS3Bucket.get("id"))
                .key(exampleAwsS3Object.get("key"))
                .build())
            .indexId(exampleAwsKendraIndex.get("id"))
            .name("Example")
            .fileFormat("CSV")
            .roleArn(exampleAwsIamRole.get("arn"))
            .build());

    }
}

    resources:
  example:
    type: aws:kendra:Faq
    properties:
      s3Path:
        bucket: ${exampleAwsS3Bucket.id}
        key: ${exampleAwsS3Object.key}
      indexId: ${exampleAwsKendraIndex.id}
      name: Example
      fileFormat: CSV
      roleArn: ${exampleAwsIamRole.arn}

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kendra_faq" "example" {
  lifecycle {
    create_before_destroy = true
  }
  s3_path {
    bucket = exampleAwsS3Bucket.id
    key    = exampleAwsS3Object.key
  }
  index_id    = exampleAwsKendraIndex.id
  name        = "Example"
  file_format = "CSV"
  role_arn    = exampleAwsIamRole.arn
}

    With Language Code

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kendra.Faq("example", {
    s3Path: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
    },
    indexId: exampleAwsKendraIndex.id,
    name: "Example",
    languageCode: "en",
    roleArn: exampleAwsIamRole.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.kendra.Faq("example",
    s3_path={
        "bucket": example_aws_s3_bucket["id"],
        "key": example_aws_s3_object["key"],
    },
    index_id=example_aws_kendra_index["id"],
    name="Example",
    language_code="en",
    role_arn=example_aws_iam_role["arn"])

    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.NewFaq(ctx, "example", &kendra.FaqArgs{
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
			IndexId:      pulumi.Any(exampleAwsKendraIndex.Id),
			Name:         pulumi.String("Example"),
			LanguageCode: pulumi.String("en"),
			RoleArn:      pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kendra.Faq("example", new()
    {
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        LanguageCode = "en",
        RoleArn = exampleAwsIamRole.Arn,
    });

});

    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.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 Faq("example", FaqArgs.builder()
            .s3Path(FaqS3PathArgs.builder()
                .bucket(exampleAwsS3Bucket.get("id"))
                .key(exampleAwsS3Object.get("key"))
                .build())
            .indexId(exampleAwsKendraIndex.get("id"))
            .name("Example")
            .languageCode("en")
            .roleArn(exampleAwsIamRole.get("arn"))
            .build());

    }
}

    resources:
  example:
    type: aws:kendra:Faq
    properties:
      s3Path:
        bucket: ${exampleAwsS3Bucket.id}
        key: ${exampleAwsS3Object.key}
      indexId: ${exampleAwsKendraIndex.id}
      name: Example
      languageCode: en
      roleArn: ${exampleAwsIamRole.arn}

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kendra_faq" "example" {
  lifecycle {
    create_before_destroy = true
  }
  s3_path {
    bucket = exampleAwsS3Bucket.id
    key    = exampleAwsS3Object.key
  }
  index_id      = exampleAwsKendraIndex.id
  name          = "Example"
  language_code = "en"
  role_arn      = exampleAwsIamRole.arn
}

    Create Faq Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Faq(name: string, args: FaqArgs, opts?: CustomResourceOptions);
    @overload
def Faq(resource_name: str,
        args: FaqArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Faq(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        index_id: Optional[str] = None,
        role_arn: Optional[str] = None,
        s3_path: Optional[FaqS3PathArgs] = None,
        description: Optional[str] = None,
        file_format: Optional[str] = None,
        language_code: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewFaq(ctx *Context, name string, args FaqArgs, opts ...ResourceOption) (*Faq, error)
    public Faq(string name, FaqArgs args, CustomResourceOptions? opts = null)
    public Faq(String name, FaqArgs args)
public Faq(String name, FaqArgs args, CustomResourceOptions options)

    type: aws:kendra:Faq
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_kendra_faq" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args FaqArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FaqArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FaqArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FaqArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FaqArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var faqResource = new Aws.Kendra.Faq("faqResource", new()
{
    IndexId = "string",
    RoleArn = "string",
    S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
    {
        Bucket = "string",
        Key = "string",
    },
    Description = "string",
    FileFormat = "string",
    LanguageCode = "string",
    Name = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := kendra.NewFaq(ctx, "faqResource", &kendra.FaqArgs{
	IndexId: pulumi.String("string"),
	RoleArn: pulumi.String("string"),
	S3Path: &kendra.FaqS3PathArgs{
		Bucket: pulumi.String("string"),
		Key:    pulumi.String("string"),
	},
	Description:  pulumi.String("string"),
	FileFormat:   pulumi.String("string"),
	LanguageCode: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Region:       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "aws_kendra_faq" "faqResource" {
  lifecycle {
    create_before_destroy = true
  }
  index_id = "string"
  role_arn = "string"
  s3_path = {
    bucket = "string"
    key    = "string"
  }
  description   = "string"
  file_format   = "string"
  language_code = "string"
  name          = "string"
  region        = "string"
  tags = {
    "string" = "string"
  }
}

    var faqResource = new Faq("faqResource", FaqArgs.builder()
    .indexId("string")
    .roleArn("string")
    .s3Path(FaqS3PathArgs.builder()
        .bucket("string")
        .key("string")
        .build())
    .description("string")
    .fileFormat("string")
    .languageCode("string")
    .name("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .build());

    faq_resource = aws.kendra.Faq("faqResource",
    index_id="string",
    role_arn="string",
    s3_path={
        "bucket": "string",
        "key": "string",
    },
    description="string",
    file_format="string",
    language_code="string",
    name="string",
    region="string",
    tags={
        "string": "string",
    })

    const faqResource = new aws.kendra.Faq("faqResource", {
    indexId: "string",
    roleArn: "string",
    s3Path: {
        bucket: "string",
        key: "string",
    },
    description: "string",
    fileFormat: "string",
    languageCode: "string",
    name: "string",
    region: "string",
    tags: {
        string: "string",
    },
});

    type: aws:kendra:Faq
properties:
    description: string
    fileFormat: string
    indexId: string
    languageCode: string
    name: string
    region: string
    roleArn: string
    s3Path:
        bucket: string
        key: string
    tags:
        string: string

    Faq Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Faq resource accepts the following input properties:

    IndexId string
    Identifier of the index for a FAQ.
    RoleArn string
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    Description string
    Description for a FAQ.
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    LanguageCode string
    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 string
    Name that should be associated with the FAQ.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    IndexId string
    Identifier of the index for a FAQ.
    RoleArn string
    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 FaqS3PathArgs

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    Description string
    Description for a FAQ.
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    LanguageCode string
    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 string
    Name that should be associated with the FAQ.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    index_id string
    Identifier of the index for a FAQ.
    role_arn string
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3_path object

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    description string
    Description for a FAQ.
    file_format string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    language_code string
    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 string
    Name that should be associated with the FAQ.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId String
    Identifier of the index for a FAQ.
    roleArn String
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    description String
    Description for a FAQ.
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode String
    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 String
    Name that should be associated with the FAQ.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId string
    Identifier of the index for a FAQ.
    roleArn string
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    description string
    Description for a FAQ.
    fileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode string
    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 string
    Name that should be associated with the FAQ.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    index_id str
    Identifier of the index for a FAQ.
    role_arn str
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3_path FaqS3PathArgs

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    description str
    Description for a FAQ.
    file_format str
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    language_code str
    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 str
    Name that should be associated with the FAQ.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId String
    Identifier of the index for a FAQ.
    roleArn String
    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 Property Map

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    description String
    Description for a FAQ.
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode String
    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 String
    Name that should be associated with the FAQ.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Faq resource produces the following output properties:

    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the FAQ was created.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    Identifier of the FAQ.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the FAQ was created.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    Identifier of the FAQ.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    created_at string
    Unix datetime that the FAQ was created.
    error_message string
    When the Status field value is FAILED, this contains a message that explains why.
    faq_id string
    Identifier of the FAQ.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at string
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the FAQ was created.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    Identifier of the FAQ.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    createdAt string
    Unix datetime that the FAQ was created.
    errorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    faqId string
    Identifier of the FAQ.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt string
    Date and time that the FAQ was last updated.
    arn str
    ARN of the FAQ.
    created_at str
    Unix datetime that the FAQ was created.
    error_message str
    When the Status field value is FAILED, this contains a message that explains why.
    faq_id str
    Identifier of the FAQ.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at str
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the FAQ was created.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    Identifier of the FAQ.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Date and time that the FAQ was last updated.

    Look up Existing Faq Resource

    Get an existing Faq resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FaqState, opts?: CustomResourceOptions): Faq
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        error_message: Optional[str] = None,
        faq_id: Optional[str] = None,
        file_format: Optional[str] = None,
        index_id: Optional[str] = None,
        language_code: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        role_arn: Optional[str] = None,
        s3_path: Optional[FaqS3PathArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        updated_at: Optional[str] = None) -> Faq
    func GetFaq(ctx *Context, name string, id IDInput, state *FaqState, opts ...ResourceOption) (*Faq, error)
    public static Faq Get(string name, Input<string> id, FaqState? state, CustomResourceOptions? opts = null)
    public static Faq get(String name, Output<String> id, FaqState state, CustomResourceOptions options)
    resources:  _:    type: aws:kendra:Faq    get:      id: ${id}
    import {
  to = aws_kendra_faq.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the FAQ was created.
    Description string
    Description for a FAQ.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    Identifier of the FAQ.
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    IndexId string
    Identifier of the index for a FAQ.
    LanguageCode string
    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 string
    Name that should be associated with the FAQ.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the FAQ was created.
    Description string
    Description for a FAQ.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    Identifier of the FAQ.
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    IndexId string
    Identifier of the index for a FAQ.
    LanguageCode string
    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 string
    Name that should be associated with the FAQ.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RoleArn string
    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 FaqS3PathArgs

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    created_at string
    Unix datetime that the FAQ was created.
    description string
    Description for a FAQ.
    error_message string
    When the Status field value is FAILED, this contains a message that explains why.
    faq_id string
    Identifier of the FAQ.
    file_format string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    index_id string
    Identifier of the index for a FAQ.
    language_code string
    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 string
    Name that should be associated with the FAQ.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn string
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3_path object

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at string
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the FAQ was created.
    description String
    Description for a FAQ.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    Identifier of the FAQ.
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId String
    Identifier of the index for a FAQ.
    languageCode String
    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 String
    Name that should be associated with the FAQ.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    createdAt string
    Unix datetime that the FAQ was created.
    description string
    Description for a FAQ.
    errorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    faqId string
    Identifier of the FAQ.
    fileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId string
    Identifier of the index for a FAQ.
    languageCode string
    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 string
    Name that should be associated with the FAQ.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn string
    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 FaqS3Path

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt string
    Date and time that the FAQ was last updated.
    arn str
    ARN of the FAQ.
    created_at str
    Unix datetime that the FAQ was created.
    description str
    Description for a FAQ.
    error_message str
    When the Status field value is FAILED, this contains a message that explains why.
    faq_id str
    Identifier of the FAQ.
    file_format str
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    index_id str
    Identifier of the index for a FAQ.
    language_code str
    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 str
    Name that should be associated with the FAQ.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role_arn str
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3_path FaqS3PathArgs

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    status str
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at str
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the FAQ was created.
    description String
    Description for a FAQ.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    Identifier of the FAQ.
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId String
    Identifier of the index for a FAQ.
    languageCode String
    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 String
    Name that should be associated with the FAQ.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    roleArn String
    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 Property Map

    S3 location of the FAQ input data. Detailed below.

    The following arguments are optional:

    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Date and time that the FAQ was last updated.

    Supporting Types

    FaqS3Path, FaqS3PathArgs

    Bucket string
    Name of the S3 bucket that contains the file.
    Key string
    Name of the file.
    Bucket string
    Name of the S3 bucket that contains the file.
    Key string
    Name of the file.
    bucket string
    Name of the S3 bucket that contains the file.
    key string
    Name of the file.
    bucket String
    Name of the S3 bucket that contains the file.
    key String
    Name of the file.
    bucket string
    Name of the S3 bucket that contains the file.
    key string
    Name of the file.
    bucket str
    Name of the S3 bucket that contains the file.
    key str
    Name of the file.
    bucket String
    Name of the S3 bucket that contains the file.
    key String
    Name of the file.

    Import

    Using pulumi import, import aws.kendra.Faq using the unique identifiers of the FAQ and index separated by a slash (/). For example:

    $ pulumi import aws:kendra/faq:Faq example faq-123456780/idx-8012925589

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial