software.amazon.awscdk.services.kendra

Interface CfnFaqProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFaqProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.135Z")
 @Stability(value=Stable)
public interface CfnFaqProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Kendra::Faq`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CfnFaqProps cfnFaqProps = CfnFaqProps.builder()
         .indexId("indexId")
         .name("name")
         .roleArn("roleArn")
         .s3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         // the properties below are optional
         .description("description")
         .fileFormat("fileFormat")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFaqProps.Builder A builder for CfnFaqProps
static class	CfnFaqProps.Jsii$Proxy An implementation for CfnFaqProps

Method Summary

Modifier and Type	Method and Description
static CfnFaqProps.Builder	builder()
default String	getDescription() `AWS::Kendra::Faq.Description`.
default String	getFileFormat() `AWS::Kendra::Faq.FileFormat`.
String	getIndexId() `AWS::Kendra::Faq.IndexId`.
String	getName() `AWS::Kendra::Faq.Name`.
String	getRoleArn() `AWS::Kendra::Faq.RoleArn`.
Object	getS3Path() `AWS::Kendra::Faq.S3Path`.
default List<CfnTag>	getTags() `AWS::Kendra::Faq.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Kendra::Faq.Description`.

getFileFormat

@Stability(value=Stable)
 @Nullable
default String getFileFormat()

`AWS::Kendra::Faq.FileFormat`.

getIndexId

@Stability(value=Stable)
 @NotNull
String getIndexId()

`AWS::Kendra::Faq.IndexId`.

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Kendra::Faq.Name`.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

`AWS::Kendra::Faq.RoleArn`.

getS3Path

@Stability(value=Stable)
 @NotNull
Object getS3Path()

`AWS::Kendra::Faq.S3Path`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Kendra::Faq.Tags`.

builder

@Stability(value=Stable)
static CfnFaqProps.Builder builder()

Returns:

a CfnFaqProps.Builder of CfnFaqProps