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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.kendra.Faq

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    A Kendra FAQ resource

    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[FaqFileFormat] = None,
            language_code: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const faqResource = new aws_native.kendra.Faq("faqResource", {
        indexId: "string",
        roleArn: "string",
        s3Path: {
            bucket: "string",
            key: "string",
        },
        description: "string",
        fileFormat: aws_native.kendra.FaqFileFormat.Csv,
        languageCode: "string",
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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
    Index ID
    RoleArn string
    FAQ role ARN
    S3Path Pulumi.AwsNative.Kendra.Inputs.FaqS3Path
    FAQ S3 path
    Description string
    FAQ description
    FileFormat Pulumi.AwsNative.Kendra.FaqFileFormat
    FAQ file format
    LanguageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    Name string
    FAQ name
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags for labeling the FAQ
    IndexId string
    Index ID
    RoleArn string
    FAQ role ARN
    S3Path FaqS3PathArgs
    FAQ S3 path
    Description string
    FAQ description
    FileFormat FaqFileFormat
    FAQ file format
    LanguageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    Name string
    FAQ name
    Tags TagArgs
    Tags for labeling the FAQ
    indexId String
    Index ID
    roleArn String
    FAQ role ARN
    s3Path FaqS3Path
    FAQ S3 path
    description String
    FAQ description
    fileFormat FaqFileFormat
    FAQ file format
    languageCode String
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    name String
    FAQ name
    tags List<Tag>
    Tags for labeling the FAQ
    indexId string
    Index ID
    roleArn string
    FAQ role ARN
    s3Path FaqS3Path
    FAQ S3 path
    description string
    FAQ description
    fileFormat FaqFileFormat
    FAQ file format
    languageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    name string
    FAQ name
    tags Tag[]
    Tags for labeling the FAQ
    index_id str
    Index ID
    role_arn str
    FAQ role ARN
    s3_path FaqS3PathArgs
    FAQ S3 path
    description str
    FAQ description
    file_format FaqFileFormat
    FAQ file format
    language_code str
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    name str
    FAQ name
    tags Sequence[TagArgs]
    Tags for labeling the FAQ
    indexId String
    Index ID
    roleArn String
    FAQ role ARN
    s3Path Property Map
    FAQ S3 path
    description String
    FAQ description
    fileFormat "CSV" | "CSV_WITH_HEADER" | "JSON"
    FAQ file format
    languageCode String
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    name String
    FAQ name
    tags List<Property Map>
    Tags for labeling the FAQ

    Outputs

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

    Arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    AwsId string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    AwsId string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    awsId String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    awsId string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    aws_id str

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    awsId String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FaqFileFormat, FaqFileFormatArgs

    Csv
    CSV
    CsvWithHeader
    CSV_WITH_HEADER
    Json
    JSON
    FaqFileFormatCsv
    CSV
    FaqFileFormatCsvWithHeader
    CSV_WITH_HEADER
    FaqFileFormatJson
    JSON
    Csv
    CSV
    CsvWithHeader
    CSV_WITH_HEADER
    Json
    JSON
    Csv
    CSV
    CsvWithHeader
    CSV_WITH_HEADER
    Json
    JSON
    CSV
    CSV
    CSV_WITH_HEADER
    CSV_WITH_HEADER
    JSON
    JSON
    "CSV"
    CSV
    "CSV_WITH_HEADER"
    CSV_WITH_HEADER
    "JSON"
    JSON

    FaqS3Path, FaqS3PathArgs

    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.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi