We recommend new projects start with resources from the AWS provider.
aws-native.kendra.Faq
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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)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.
Faq Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Faq resource accepts the following input properties:
- IndexId string
- Index ID
- RoleArn string
- FAQ role ARN
- S3Path
Pulumi.Aws Native. Kendra. Inputs. Faq S3Path 
- FAQ S3 path
- Description string
- FAQ description
- FileFormat Pulumi.Aws Native. Kendra. Faq File Format 
- 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
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- Tags for labeling the FAQ
- IndexId string
- Index ID
- RoleArn string
- FAQ role ARN
- S3Path
FaqS3Path Args 
- FAQ S3 path
- Description string
- FAQ description
- FileFormat FaqFile Format 
- 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
- 
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 FaqFile Format 
- 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
- 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 FaqFile Format 
- 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
- Tag[]
- Tags for labeling the FAQ
- index_id str
- Index ID
- role_arn str
- FAQ role ARN
- s3_path FaqS3Path Args 
- FAQ S3 path
- description str
- FAQ description
- file_format FaqFile Format 
- 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
- 
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
- 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:
Supporting Types
FaqFileFormat, FaqFileFormatArgs      
- Csv
- CSV
- CsvWith Header 
- CSV_WITH_HEADER
- Json
- JSON
- FaqFile Format Csv 
- CSV
- FaqFile Format Csv With Header 
- CSV_WITH_HEADER
- FaqFile Format Json 
- JSON
- Csv
- CSV
- CsvWith Header 
- CSV_WITH_HEADER
- Json
- JSON
- Csv
- CSV
- CsvWith Header 
- 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    
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.