AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Faq

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

Example Usage

Basic

Coming soon!

Coming soon!

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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())
            .sourceS3Path(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .tags(Map.of("Name", "Example Kendra Faq"))
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  example:
    type: aws:kendra:Faq
    properties:
      indexId: ${aws_kendra_index.example.id}
      roleArn: ${aws_iam_role.example.arn}
      sourceS3Path:
        - bucket: ${aws_s3_bucket.example.id}
          key: ${aws_s3_object.example.key}
      tags:
        Name: Example Kendra Faq

With File Format

Coming soon!

Coming soon!

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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())
            .sourceS3Path(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  example:
    type: aws:kendra:Faq
    properties:
      indexId: ${aws_kendra_index.example.id}
      fileFormat: CSV
      roleArn: ${aws_iam_role.example.arn}
      sourceS3Path:
        - bucket: ${aws_s3_bucket.example.id}
          key: ${aws_s3_object.example.key}

With Language Code

Coming soon!

Coming soon!

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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())
            .sourceS3Path(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  example:
    type: aws:kendra:Faq
    properties:
      indexId: ${aws_kendra_index.example.id}
      languageCode: en
      roleArn: ${aws_iam_role.example.arn}
      sourceS3Path:
        - bucket: ${aws_s3_bucket.example.id}
          key: ${aws_s3_object.example.key}

Create a Faq Resource

new Faq(name: string, args: FaqArgs, opts?: CustomResourceOptions);
@overload
def Faq(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        description: 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,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None)
@overload
def Faq(resource_name: str,
        args: FaqArgs,
        opts: Optional[ResourceOptions] = 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.

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.

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 FaqS3PathArgs

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

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>
TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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
TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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>
tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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}
tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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]
tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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>
tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

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.

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.

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.

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.

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.

updatedAt String

The date and time that the FAQ was last updated.

Look up an 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 FaqS3PathArgs

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

Status string

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

Tags Dictionary<string, string>
TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

Status string

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

Tags map[string]string
TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

status String

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

tags Map<String,String>
tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

status string

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

tags {[key: string]: string}
tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

status str

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

tags Mapping[str, str]
tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

status String

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

tags Map<String>
tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

updatedAt String

The date and time that the FAQ was last updated.

Supporting Types

FaqS3Path

Bucket string

The name of the S3 bucket that contains the file.

Key string

The name of the file.

Bucket string

The name of the S3 bucket that contains the file.

Key string

The name of the file.

bucket String

The name of the S3 bucket that contains the file.

key String

The name of the file.

bucket string

The name of the S3 bucket that contains the file.

key string

The name of the file.

bucket str

The name of the S3 bucket that contains the file.

key str

The name of the file.

bucket String

The name of the S3 bucket that contains the file.

key String

The name of the file.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.