Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. kendra
  5. Faq

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.kendra.Faq

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
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", {
    indexId: exampleAwsKendraIndex.id,
    name: "Example",
    roleArn: exampleAwsIamRole.arn,
    s3Path: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
    },
    tags: {
        Name: "Example Kendra Faq",
    },
});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
			Name:    pulumi.String("Example"),
			RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
			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()
    {
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        RoleArn = exampleAwsIamRole.Arn,
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
        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.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(exampleAwsKendraIndex.id())
            .name("Example")
            .roleArn(exampleAwsIamRole.arn())
            .s3Path(FaqS3PathArgs.builder()
                .bucket(exampleAwsS3Bucket.id())
                .key(exampleAwsS3Object.key())
                .build())
            .tags(Map.of("Name", "Example Kendra Faq"))
            .build());

    }
}

    resources:
  example:
    type: aws:kendra:Faq
    properties:
      indexId: ${exampleAwsKendraIndex.id}
      name: Example
      roleArn: ${exampleAwsIamRole.arn}
      s3Path:
        bucket: ${exampleAwsS3Bucket.id}
        key: ${exampleAwsS3Object.key}
      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", {
    indexId: exampleAwsKendraIndex.id,
    name: "Example",
    fileFormat: "CSV",
    roleArn: exampleAwsIamRole.arn,
    s3Path: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
    },
});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			IndexId:    pulumi.Any(exampleAwsKendraIndex.Id),
			Name:       pulumi.String("Example"),
			FileFormat: pulumi.String("CSV"),
			RoleArn:    pulumi.Any(exampleAwsIamRole.Arn),
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
		})
		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()
    {
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        FileFormat = "CSV",
        RoleArn = exampleAwsIamRole.Arn,
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
    });

});

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

    }
}

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

    With Language Code

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			IndexId:      pulumi.Any(exampleAwsKendraIndex.Id),
			Name:         pulumi.String("Example"),
			LanguageCode: pulumi.String("en"),
			RoleArn:      pulumi.Any(exampleAwsIamRole.Arn),
			S3Path: &kendra.FaqS3PathArgs{
				Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
				Key:    pulumi.Any(exampleAwsS3Object.Key),
			},
		})
		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()
    {
        IndexId = exampleAwsKendraIndex.Id,
        Name = "Example",
        LanguageCode = "en",
        RoleArn = exampleAwsIamRole.Arn,
        S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
        },
    });

});

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

    }
}

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

    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,
        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.

    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.

    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",
    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"),
	Tags: pulumi.StringMap{
		"string": pulumi.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")
    .tags(Map.of("string", "string"))
    .build());

    faq_resource = aws.kendra.Faq("faqResource",
    index_id="string",
    role_arn="string",
    s3_path=aws.kendra.FaqS3PathArgs(
        bucket="string",
        key="string",
    ),
    description="string",
    file_format="string",
    language_code="string",
    name="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",
    tags: {
        string: "string",
    },
});

    type: aws:kendra:Faq
properties:
    description: string
    fileFormat: string
    indexId: string
    languageCode: string
    name: 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

    The Faq resource accepts the following input properties:

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

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    Description string
    The description for a FAQ.
    FileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    LanguageCode 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 string
    The name that should be associated with the FAQ.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    IndexId string
    The identifier of the index for a FAQ.
    RoleArn 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 FaqS3PathArgs

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    Description string
    The description for a FAQ.
    FileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    LanguageCode 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 string
    The name that should be associated with the FAQ.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId String
    The identifier of the index for a FAQ.
    roleArn 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 FaqS3Path

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    description String
    The description for a FAQ.
    fileFormat String
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode 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 String
    The name that should be associated with the FAQ.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId string
    The identifier of the index for a FAQ.
    roleArn 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 FaqS3Path

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    description string
    The description for a FAQ.
    fileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode 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 string
    The name that should be associated with the FAQ.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    index_id str
    The identifier of the index for a FAQ.
    role_arn str
    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.
    s3_path FaqS3PathArgs

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    description str
    The description for a FAQ.
    file_format str
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    language_code str
    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 str
    The name that should be associated with the FAQ.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    indexId String
    The identifier of the index for a FAQ.
    roleArn 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 Property Map

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    description String
    The description for a FAQ.
    fileFormat String
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    languageCode 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 String
    The name that should be associated with the FAQ.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags 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
    The 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
    The identifier of the FAQ.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdatedAt string
    The date and time that the FAQ was last updated.
    Arn string
    ARN of the FAQ.
    CreatedAt string
    The 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
    The identifier of the FAQ.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdatedAt string
    The date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    The 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
    The identifier of the FAQ.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt String
    The date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    createdAt string
    The 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
    The identifier of the FAQ.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt string
    The date and time that the FAQ was last updated.
    arn str
    ARN of the FAQ.
    created_at str
    The 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
    The identifier of the FAQ.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updated_at str
    The date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    The 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
    The identifier of the FAQ.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt String
    The 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,
        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)
    Resource lookup is not supported in YAML
    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
    The Unix datetime that the FAQ was created.
    Description string
    The description for a FAQ.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    The identifier of the FAQ.
    FileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    IndexId string
    The identifier of the index for a FAQ.
    LanguageCode 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 string
    The name that should be associated with the FAQ.
    RoleArn 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 FaqS3Path

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    Status string
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdatedAt string
    The date and time that the FAQ was last updated.
    Arn string
    ARN of the FAQ.
    CreatedAt string
    The Unix datetime that the FAQ was created.
    Description string
    The description for a FAQ.
    ErrorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    FaqId string
    The identifier of the FAQ.
    FileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    IndexId string
    The identifier of the index for a FAQ.
    LanguageCode 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 string
    The name that should be associated with the FAQ.
    RoleArn 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 FaqS3PathArgs

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    Status string
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UpdatedAt string
    The date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    The Unix datetime that the FAQ was created.
    description String
    The description for a FAQ.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    The identifier of the FAQ.
    fileFormat String
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId String
    The identifier of the index for a FAQ.
    languageCode 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 String
    The name that should be associated with the FAQ.
    roleArn 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 FaqS3Path

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    status String
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt String
    The date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    createdAt string
    The Unix datetime that the FAQ was created.
    description string
    The description for a FAQ.
    errorMessage string
    When the Status field value is FAILED, this contains a message that explains why.
    faqId string
    The identifier of the FAQ.
    fileFormat string
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId string
    The identifier of the index for a FAQ.
    languageCode 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 string
    The name that should be associated with the FAQ.
    roleArn 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 FaqS3Path

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    status string
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt string
    The date and time that the FAQ was last updated.
    arn str
    ARN of the FAQ.
    created_at str
    The Unix datetime that the FAQ was created.
    description str
    The description for a FAQ.
    error_message str
    When the Status field value is FAILED, this contains a message that explains why.
    faq_id str
    The identifier of the FAQ.
    file_format str
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    index_id str
    The identifier of the index for a FAQ.
    language_code str
    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 str
    The name that should be associated with the FAQ.
    role_arn str
    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.
    s3_path FaqS3PathArgs

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    status str
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updated_at str
    The date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    The Unix datetime that the FAQ was created.
    description String
    The description for a FAQ.
    errorMessage String
    When the Status field value is FAILED, this contains a message that explains why.
    faqId String
    The identifier of the FAQ.
    fileFormat String
    The file format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    indexId String
    The identifier of the index for a FAQ.
    languageCode 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 String
    The name that should be associated with the FAQ.
    roleArn 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 Property Map

    The S3 location of the FAQ input data. Detailed below.

    The s3_path configuration block supports the following arguments:

    status String
    The 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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    updatedAt String
    The date and time that the FAQ was last updated.

    Supporting Types

    FaqS3Path, FaqS3PathArgs

    Bucket string
    The name of the S3 bucket that contains the file.
    Key string

    The name of the file.

    The following arguments are optional:

    Bucket string
    The name of the S3 bucket that contains the file.
    Key string

    The name of the file.

    The following arguments are optional:

    bucket String
    The name of the S3 bucket that contains the file.
    key String

    The name of the file.

    The following arguments are optional:

    bucket string
    The name of the S3 bucket that contains the file.
    key string

    The name of the file.

    The following arguments are optional:

    bucket str
    The name of the S3 bucket that contains the file.
    key str

    The name of the file.

    The following arguments are optional:

    bucket String
    The name of the S3 bucket that contains the file.
    key String

    The name of the file.

    The following arguments are optional:

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws