Class CfnKnowledgeBase

Specifies a knowledge base.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnKnowledgeBase
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Wisdom
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnKnowledgeBase : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnKnowledgeBase
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html

CloudformationResource: AWS::Wisdom::KnowledgeBase

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" }
        },
        ManagedSourceConfiguration = new ManagedSourceConfigurationProperty {
            WebCrawlerConfiguration = new WebCrawlerConfigurationProperty {
                UrlConfiguration = new UrlConfigurationProperty {
                    SeedUrls = new [] { new SeedUrlProperty {
                        Url = "url"
                    } }
                },

                // the properties below are optional
                CrawlerLimits = new CrawlerLimitsProperty {
                    RateLimit = 123
                },
                ExclusionFilters = new [] { "exclusionFilters" },
                InclusionFilters = new [] { "inclusionFilters" },
                Scope = "scope"
            }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VectorIngestionConfiguration = new VectorIngestionConfigurationProperty {
        ChunkingConfiguration = new ChunkingConfigurationProperty {
            ChunkingStrategy = "chunkingStrategy",

            // the properties below are optional
            FixedSizeChunkingConfiguration = new FixedSizeChunkingConfigurationProperty {
                MaxTokens = 123,
                OverlapPercentage = 123
            },
            HierarchicalChunkingConfiguration = new HierarchicalChunkingConfigurationProperty {
                LevelConfigurations = new [] { new HierarchicalChunkingLevelConfigurationProperty {
                    MaxTokens = 123
                } },
                OverlapTokens = 123
            },
            SemanticChunkingConfiguration = new SemanticChunkingConfigurationProperty {
                BreakpointPercentileThreshold = 123,
                BufferSize = 123,
                MaxTokens = 123
            }
        },
        ParsingConfiguration = new ParsingConfigurationProperty {
            ParsingStrategy = "parsingStrategy",

            // the properties below are optional
            BedrockFoundationModelConfiguration = new BedrockFoundationModelConfigurationProperty {
                ModelArn = "modelArn",

                // the properties below are optional
                ParsingPrompt = new ParsingPromptProperty {
                    ParsingPromptText = "parsingPromptText"
                }
            }
        }
    }
});

Synopsis

Constructors

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
CfnKnowledgeBase(Construct, String, ICfnKnowledgeBaseProps)

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

This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.
SourceConfiguration

The source of the knowledge base content.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tags used to organize, track, or control access for this resource.
VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

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

CfnKnowledgeBase(Construct, String, ICfnKnowledgeBaseProps)

public CfnKnowledgeBase(Construct scope, string id, ICfnKnowledgeBaseProps 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 ICfnKnowledgeBaseProps

Resource properties.

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

KnowledgeBaseType

The type of knowledge base.

public virtual string KnowledgeBaseType { get; set; }
Property Value

System.String

Name

The name of the knowledge base.

public virtual string Name { get; set; }
Property Value

System.String

RenderingConfiguration

Information about how to render the content.

public virtual object RenderingConfiguration { get; set; }
Property Value

System.Object

ServerSideEncryptionConfiguration

This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.

public virtual object ServerSideEncryptionConfiguration { get; set; }
Property Value

System.Object

SourceConfiguration

The source of the knowledge base content.

public virtual object SourceConfiguration { get; set; }
Property Value

System.Object

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

The tags used to organize, track, or control access for this resource.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

public virtual object VectorIngestionConfiguration { get; set; }
Property Value

System.Object

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>

Overrides

Implements