Class CfnFaq
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kendra.CfnFaq
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-15T21:09:20.992Z")
@Stability(Stable)
public class CfnFaq
extends CfnResource
implements IInspectable, ITaggable
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") .languageCode("languageCode") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnFaq
.static interface
Information required to find a specific file in an Amazon S3 bucket.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFaq
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFaq
(software.amazon.jsii.JsiiObjectRef objRef) CfnFaq
(software.constructs.Construct scope, String id, CfnFaqProps props) -
Method Summary
Modifier and TypeMethodDescriptionarn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
.The identifier for the FAQ.A description for the FAQ.The format of the input file.The identifier of the index that contains the FAQ.The code for a language.getName()
The name that you assigned the FAQ when you created or updated the FAQ.The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) A description for the FAQ.void
setFileFormat
(String value) The format of the input file.void
setIndexId
(String value) The identifier of the index that contains the FAQ.void
setLanguageCode
(String value) The code for a language.void
The name that you assigned the FAQ when you created or updated the FAQ.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.void
setS3Path
(IResolvable value) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.void
setS3Path
(CfnFaq.S3PathProperty value) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnFaq
protected CfnFaq(software.amazon.jsii.JsiiObjectRef objRef) -
CfnFaq
protected CfnFaq(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnFaq
@Stability(Stable) public CfnFaq(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFaqProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
. -
getAttrId
The identifier for the FAQ. For example:.f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getIndexId
The identifier of the index that contains the FAQ. -
setIndexId
The identifier of the index that contains the FAQ. -
getName
The name that you assigned the FAQ when you created or updated the FAQ. -
setName
The name that you assigned the FAQ when you created or updated the FAQ. -
getRoleArn
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ. -
setRoleArn
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ. -
getS3Path
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. -
setS3Path
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. -
setS3Path
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. -
getDescription
A description for the FAQ. -
setDescription
A description for the FAQ. -
getFileFormat
The format of the input file. -
setFileFormat
The format of the input file. -
getLanguageCode
The code for a language. -
setLanguageCode
The code for a language. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-