Class CfnFaq
Creates an new set of frequently asked question (FAQ) questions and answers.
Inherited Members
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFaq : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFaq
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html
CloudformationResource: AWS::Kendra::Faq
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var cfnFaq = new CfnFaq(this, "MyCfnFaq", new CfnFaqProps {
IndexId = "indexId",
Name = "name",
RoleArn = "roleArn",
S3Path = new S3PathProperty {
Bucket = "bucket",
Key = "key"
},
// the properties below are optional
Description = "description",
FileFormat = "fileFormat",
LanguageCode = "languageCode",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnFaq(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFaq(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFaq(Construct, String, ICfnFaqProps) |
Properties
AttrArn |
|
AttrId | The identifier for the FAQ. For example:. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the FAQ. |
FileFormat | The format of the input file. |
IndexId | The identifier of the index that contains the FAQ. |
LanguageCode | The code for a language. |
Name | The name that you assigned the FAQ when you created or updated the FAQ. |
RoleArn | The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ. |
S3Path | The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFaq(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFaq(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFaq(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFaq(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFaq(Construct, String, ICfnFaqProps)
public CfnFaq(Construct scope, string id, ICfnFaqProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFaqProps
Resource properties.
Properties
AttrArn
arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The identifier for the FAQ. For example:.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the FAQ.
public virtual string Description { get; set; }
Property Value
System.String
FileFormat
The format of the input file.
public virtual string FileFormat { get; set; }
Property Value
System.String
IndexId
The identifier of the index that contains the FAQ.
public virtual string IndexId { get; set; }
Property Value
System.String
LanguageCode
The code for a language.
public virtual string LanguageCode { get; set; }
Property Value
System.String
Name
The name that you assigned the FAQ when you created or updated the FAQ.
public virtual string Name { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
public virtual string RoleArn { get; set; }
Property Value
System.String
S3Path
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
public virtual object S3Path { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>