Class CfnKnowledgeBase
A CloudFormation AWS::Wisdom::KnowledgeBase
.
Inherited Members
Namespace: Amazon.CDK.AWS.Wisdom
Assembly: Amazon.CDK.AWS.Wisdom.dll
Syntax (csharp)
public class CfnKnowledgeBase : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnKnowledgeBase
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a knowledge base.
CloudformationResource: AWS::Wisdom::KnowledgeBase
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html
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.Wisdom;
var cfnKnowledgeBase = new CfnKnowledgeBase(this, "MyCfnKnowledgeBase", new CfnKnowledgeBaseProps {
KnowledgeBaseType = "knowledgeBaseType",
Name = "name",
// the properties below are optional
Description = "description",
RenderingConfiguration = new RenderingConfigurationProperty {
TemplateUri = "templateUri"
},
ServerSideEncryptionConfiguration = new ServerSideEncryptionConfigurationProperty {
KmsKeyId = "kmsKeyId"
},
SourceConfiguration = new SourceConfigurationProperty {
AppIntegrations = new AppIntegrationsConfigurationProperty {
AppIntegrationArn = "appIntegrationArn",
// the properties below are optional
ObjectFields = new [] { "objectFields" }
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnKnowledgeBase(Construct, String, ICfnKnowledgeBaseProps) | Create a new |
CfnKnowledgeBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnKnowledgeBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrKnowledgeBaseArn | The Amazon Resource Name (ARN) of the knowledge base. |
AttrKnowledgeBaseId | The ID of the knowledge base. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description. |
KnowledgeBaseType | The type of knowledge base. |
Name | The name of the knowledge base. |
RenderingConfiguration | Information about how to render the content. |
ServerSideEncryptionConfiguration | The KMS key used for encryption. |
SourceConfiguration | The source of the knowledge base content. |
Tags | The tags used to organize, track, or control access for this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnKnowledgeBase(Construct, String, ICfnKnowledgeBaseProps)
Create a new AWS::Wisdom::KnowledgeBase
.
public CfnKnowledgeBase(Construct scope, string id, ICfnKnowledgeBaseProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnKnowledgeBaseProps
- resource properties.
CfnKnowledgeBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnKnowledgeBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnKnowledgeBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnKnowledgeBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrKnowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
public virtual string AttrKnowledgeBaseArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: KnowledgeBaseArn
AttrKnowledgeBaseId
The ID of the knowledge base.
public virtual string AttrKnowledgeBaseId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: KnowledgeBaseId
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
The description.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
KnowledgeBaseType
The type of knowledge base.
public virtual string KnowledgeBaseType { get; set; }
Property Value
System.String
Remarks
Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
Name
The name of the knowledge base.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
RenderingConfiguration
Information about how to render the content.
public virtual object RenderingConfiguration { get; set; }
Property Value
System.Object
Remarks
ServerSideEncryptionConfiguration
The KMS key used for encryption.
public virtual object ServerSideEncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
SourceConfiguration
The source of the knowledge base content.
public virtual object SourceConfiguration { get; set; }
Property Value
System.Object
Remarks
Only set this argument for EXTERNAL knowledge bases.
Tags
The tags used to organize, track, or control access for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>