software.amazon.awscdk.services.kendra

Class CfnFaq

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kendra.CfnFaq

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.238Z")
public class CfnFaq
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Kendra::Faq`.

Creates an new set of frequently asked question (FAQ) questions and answers.

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.*;
 CfnFaq cfnFaq = CfnFaq.Builder.create(this, "MyCfnFaq")
         .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	Class and Description
static class	CfnFaq.Builder A fluent builder for CfnFaq.
static interface	CfnFaq.S3PathProperty Information required to find a specific file in an Amazon S3 bucket.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFaq(Construct scope, java.lang.String id, CfnFaqProps props) Create a new `AWS::Kendra::Faq`.
protected	CfnFaq(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFaq(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() `arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7`.
java.lang.String	getAttrId() The identifier for the FAQ.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description for the FAQ.
java.lang.String	getFileFormat() The format of the input file.
java.lang.String	getIndexId() The identifier of the index that contains the FAQ.
java.lang.String	getName() The name that you assigned the FAQ when you created or updated the FAQ.
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
java.lang.Object	getS3Path() The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description for the FAQ.
void	setFileFormat(java.lang.String value) The format of the input file.
void	setIndexId(java.lang.String value) The identifier of the index that contains the FAQ.
void	setName(java.lang.String value) The name that you assigned the FAQ when you created or updated the FAQ.
void	setRoleArn(java.lang.String value) The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
void	setS3Path(CfnFaq.S3PathProperty value) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
void	setS3Path(IResolvable value) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFaq

protected CfnFaq(software.amazon.jsii.JsiiObjectRef objRef)

CfnFaq

protected CfnFaq(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFaq

public CfnFaq(Construct scope,
              java.lang.String id,
              CfnFaqProps props)

Create a new `AWS::Kendra::Faq`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrId

public java.lang.String getAttrId()

The identifier for the FAQ. For example:.

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getIndexId

public java.lang.String getIndexId()

The identifier of the index that contains the FAQ.

setIndexId

public void setIndexId(java.lang.String value)

The identifier of the index that contains the FAQ.

getName

public java.lang.String getName()

The name that you assigned the FAQ when you created or updated the FAQ.

setName

public void setName(java.lang.String value)

The name that you assigned the FAQ when you created or updated the FAQ.

getRoleArn

public java.lang.String getRoleArn()

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.

setRoleArn

public void setRoleArn(java.lang.String value)

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.

getS3Path

public java.lang.Object getS3Path()

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

setS3Path

public void setS3Path(IResolvable value)

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

setS3Path

public void setS3Path(CfnFaq.S3PathProperty value)

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

getDescription

public java.lang.String getDescription()

A description for the FAQ.

setDescription

public void setDescription(java.lang.String value)

A description for the FAQ.

getFileFormat

public java.lang.String getFileFormat()

The format of the input file.

You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

Valid values are:

• CSV
• CSV_WITH_HEADER
• JSON

setFileFormat

public void setFileFormat(java.lang.String value)

The format of the input file.

You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

Valid values are:

• CSV
• CSV_WITH_HEADER
• JSON