Try AWS Native preview for resources not in the classic version.
aws.kendra.Faq
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Resource for managing an AWS Kendra FAQ.
Example Usage
Basic
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 = aws_kendra_index.Example.Id,
RoleArn = aws_iam_role.Example.Arn,
S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
{
Bucket = aws_s3_bucket.Example.Id,
Key = aws_s3_object.Example.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(aws_kendra_index.Example.Id),
RoleArn: pulumi.Any(aws_iam_role.Example.Arn),
S3Path: &kendra.FaqS3PathArgs{
Bucket: pulumi.Any(aws_s3_bucket.Example.Id),
Key: pulumi.Any(aws_s3_object.Example.Key),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Kendra Faq"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.tags(Map.of("Name", "Example Kendra Faq"))
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.kendra.Faq("example",
index_id=aws_kendra_index["example"]["id"],
role_arn=aws_iam_role["example"]["arn"],
s3_path=aws.kendra.FaqS3PathArgs(
bucket=aws_s3_bucket["example"]["id"],
key=aws_s3_object["example"]["key"],
),
tags={
"Name": "Example Kendra Faq",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Faq("example", {
indexId: aws_kendra_index.example.id,
roleArn: aws_iam_role.example.arn,
s3Path: {
bucket: aws_s3_bucket.example.id,
key: aws_s3_object.example.key,
},
tags: {
Name: "Example Kendra Faq",
},
});
resources:
example:
type: aws:kendra:Faq
properties:
indexId: ${aws_kendra_index.example.id}
roleArn: ${aws_iam_role.example.arn}
s3Path:
bucket: ${aws_s3_bucket.example.id}
key: ${aws_s3_object.example.key}
tags:
Name: Example Kendra Faq
With File Format
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 = aws_kendra_index.Example.Id,
FileFormat = "CSV",
RoleArn = aws_iam_role.Example.Arn,
S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
{
Bucket = aws_s3_bucket.Example.Id,
Key = aws_s3_object.Example.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(aws_kendra_index.Example.Id),
FileFormat: pulumi.String("CSV"),
RoleArn: pulumi.Any(aws_iam_role.Example.Arn),
S3Path: &kendra.FaqS3PathArgs{
Bucket: pulumi.Any(aws_s3_bucket.Example.Id),
Key: pulumi.Any(aws_s3_object.Example.Key),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.fileFormat("CSV")
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.kendra.Faq("example",
index_id=aws_kendra_index["example"]["id"],
file_format="CSV",
role_arn=aws_iam_role["example"]["arn"],
s3_path=aws.kendra.FaqS3PathArgs(
bucket=aws_s3_bucket["example"]["id"],
key=aws_s3_object["example"]["key"],
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Faq("example", {
indexId: aws_kendra_index.example.id,
fileFormat: "CSV",
roleArn: aws_iam_role.example.arn,
s3Path: {
bucket: aws_s3_bucket.example.id,
key: aws_s3_object.example.key,
},
});
resources:
example:
type: aws:kendra:Faq
properties:
indexId: ${aws_kendra_index.example.id}
fileFormat: CSV
roleArn: ${aws_iam_role.example.arn}
s3Path:
bucket: ${aws_s3_bucket.example.id}
key: ${aws_s3_object.example.key}
With Language Code
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 = aws_kendra_index.Example.Id,
LanguageCode = "en",
RoleArn = aws_iam_role.Example.Arn,
S3Path = new Aws.Kendra.Inputs.FaqS3PathArgs
{
Bucket = aws_s3_bucket.Example.Id,
Key = aws_s3_object.Example.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(aws_kendra_index.Example.Id),
LanguageCode: pulumi.String("en"),
RoleArn: pulumi.Any(aws_iam_role.Example.Arn),
S3Path: &kendra.FaqS3PathArgs{
Bucket: pulumi.Any(aws_s3_bucket.Example.Id),
Key: pulumi.Any(aws_s3_object.Example.Key),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Faq;
import com.pulumi.aws.kendra.FaqArgs;
import com.pulumi.aws.kendra.inputs.FaqS3PathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Faq("example", FaqArgs.builder()
.indexId(aws_kendra_index.example().id())
.languageCode("en")
.roleArn(aws_iam_role.example().arn())
.s3Path(FaqS3PathArgs.builder()
.bucket(aws_s3_bucket.example().id())
.key(aws_s3_object.example().key())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.kendra.Faq("example",
index_id=aws_kendra_index["example"]["id"],
language_code="en",
role_arn=aws_iam_role["example"]["arn"],
s3_path=aws.kendra.FaqS3PathArgs(
bucket=aws_s3_bucket["example"]["id"],
key=aws_s3_object["example"]["key"],
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Faq("example", {
indexId: aws_kendra_index.example.id,
languageCode: "en",
roleArn: aws_iam_role.example.arn,
s3Path: {
bucket: aws_s3_bucket.example.id,
key: aws_s3_object.example.key,
},
});
resources:
example:
type: aws:kendra:Faq
properties:
indexId: ${aws_kendra_index.example.id}
languageCode: en
roleArn: ${aws_iam_role.example.arn}
s3Path:
bucket: ${aws_s3_bucket.example.id}
key: ${aws_s3_object.example.key}
Create 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)
@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)
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:
- Index
Id string The identifier of the index for a FAQ.
- Role
Arn 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
Faq
S3Path 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.
- File
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- Language
Code 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.
- 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.
- Index
Id string The identifier of the index for a FAQ.
- Role
Arn 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
Faq
S3Path Args 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.
- File
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- Language
Code 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.
- 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.
- index
Id String The identifier of the index for a FAQ.
- role
Arn 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
Faq
S3Path 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.
- file
Format String The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- language
Code 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.
- 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.
- index
Id string The identifier of the index for a FAQ.
- role
Arn 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
Faq
S3Path 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.
- file
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- language
Code 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.
- {[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 FaqS3Path Args 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.
- 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.
- index
Id String The identifier of the index for a FAQ.
- role
Arn 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.
- file
Format String The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- language
Code 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.
- 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.
- Created
At string The 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 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.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Updated
At string The date and time that the FAQ was last updated.
- Arn string
ARN of the FAQ.
- Created
At string The 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 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.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Updated
At string The date and time that the FAQ was last updated.
- arn String
ARN of the FAQ.
- created
At String The 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 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.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At String The date and time that the FAQ was last updated.
- arn string
ARN of the FAQ.
- created
At string The 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 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.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At 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.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated_
at str The date and time that the FAQ was last updated.
- arn String
ARN of the FAQ.
- created
At String The 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 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.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At 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.
- Arn string
ARN of the FAQ.
- Created
At string The Unix datetime that the FAQ was created.
- Description string
The description for a FAQ.
- Error
Message string When the Status field value is
FAILED
, this contains a message that explains why.- Faq
Id string The identifier of the FAQ.
- File
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- Index
Id string The identifier of the index for a FAQ.
- Language
Code 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.
- Role
Arn 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
Faq
S3Path 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.
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Updated
At string The date and time that the FAQ was last updated.
- Arn string
ARN of the FAQ.
- Created
At string The Unix datetime that the FAQ was created.
- Description string
The description for a FAQ.
- Error
Message string When the Status field value is
FAILED
, this contains a message that explains why.- Faq
Id string The identifier of the FAQ.
- File
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- Index
Id string The identifier of the index for a FAQ.
- Language
Code 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.
- Role
Arn 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
Faq
S3Path Args 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.
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Updated
At string The date and time that the FAQ was last updated.
- arn String
ARN of the FAQ.
- created
At String The Unix datetime that the FAQ was created.
- description String
The description for a FAQ.
- error
Message String When the Status field value is
FAILED
, this contains a message that explains why.- faq
Id String The identifier of the FAQ.
- file
Format String The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- index
Id String The identifier of the index for a FAQ.
- language
Code 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.
- role
Arn 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
Faq
S3Path 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.
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At String The date and time that the FAQ was last updated.
- arn string
ARN of the FAQ.
- created
At string The Unix datetime that the FAQ was created.
- description string
The description for a FAQ.
- error
Message string When the Status field value is
FAILED
, this contains a message that explains why.- faq
Id string The identifier of the FAQ.
- file
Format string The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- index
Id string The identifier of the index for a FAQ.
- language
Code 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.
- role
Arn 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
Faq
S3Path 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.
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At 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 FaqS3Path Args 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.
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated_
at str The date and time that the FAQ was last updated.
- arn String
ARN of the FAQ.
- created
At String The Unix datetime that the FAQ was created.
- description String
The description for a FAQ.
- error
Message String When the Status field value is
FAILED
, this contains a message that explains why.- faq
Id String The identifier of the FAQ.
- file
Format String The file format used by the input files for the FAQ. Valid Values are
CSV
,CSV_WITH_HEADER
,JSON
.- index
Id String The identifier of the index for a FAQ.
- language
Code 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.
- role
Arn 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.
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- updated
At String The date and time that the FAQ was last updated.
Supporting Types
FaqS3Path, FaqS3PathArgs
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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.