Class CfnKnowledgeBaseProps

Properties for defining a CfnKnowledgeBase.

Inheritance
System.Object
CfnKnowledgeBaseProps
Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnKnowledgeBaseProps : Object, ICfnKnowledgeBaseProps
Syntax (vb)
Public Class CfnKnowledgeBaseProps
    Inherits Object
    Implements ICfnKnowledgeBaseProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-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_bedrock;

var cfnKnowledgeBaseProps = new CfnKnowledgeBaseProps {
    KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
        Type = "type",

        // the properties below are optional
        KendraKnowledgeBaseConfiguration = new KendraKnowledgeBaseConfigurationProperty {
            KendraIndexArn = "kendraIndexArn"
        },
        SqlKnowledgeBaseConfiguration = new SqlKnowledgeBaseConfigurationProperty {
            Type = "type",

            // the properties below are optional
            RedshiftConfiguration = new RedshiftConfigurationProperty {
                QueryEngineConfiguration = new RedshiftQueryEngineConfigurationProperty {
                    Type = "type",

                    // the properties below are optional
                    ProvisionedConfiguration = new RedshiftProvisionedConfigurationProperty {
                        AuthConfiguration = new RedshiftProvisionedAuthConfigurationProperty {
                            Type = "type",

                            // the properties below are optional
                            DatabaseUser = "databaseUser",
                            UsernamePasswordSecretArn = "usernamePasswordSecretArn"
                        },
                        ClusterIdentifier = "clusterIdentifier"
                    },
                    ServerlessConfiguration = new RedshiftServerlessConfigurationProperty {
                        AuthConfiguration = new RedshiftServerlessAuthConfigurationProperty {
                            Type = "type",

                            // the properties below are optional
                            UsernamePasswordSecretArn = "usernamePasswordSecretArn"
                        },
                        WorkgroupArn = "workgroupArn"
                    }
                },
                StorageConfigurations = new [] { new RedshiftQueryEngineStorageConfigurationProperty {
                    Type = "type",

                    // the properties below are optional
                    AwsDataCatalogConfiguration = new RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty {
                        TableNames = new [] { "tableNames" }
                    },
                    RedshiftConfiguration = new RedshiftQueryEngineRedshiftStorageConfigurationProperty {
                        DatabaseName = "databaseName"
                    }
                } },

                // the properties below are optional
                QueryGenerationConfiguration = new QueryGenerationConfigurationProperty {
                    ExecutionTimeoutSeconds = 123,
                    GenerationContext = new QueryGenerationContextProperty {
                        CuratedQueries = new [] { new CuratedQueryProperty {
                            NaturalLanguage = "naturalLanguage",
                            Sql = "sql"
                        } },
                        Tables = new [] { new QueryGenerationTableProperty {
                            Name = "name",

                            // the properties below are optional
                            Columns = new [] { new QueryGenerationColumnProperty {
                                Description = "description",
                                Inclusion = "inclusion",
                                Name = "name"
                            } },
                            Description = "description",
                            Inclusion = "inclusion"
                        } }
                    }
                }
            }
        },
        VectorKnowledgeBaseConfiguration = new VectorKnowledgeBaseConfigurationProperty {
            EmbeddingModelArn = "embeddingModelArn",

            // the properties below are optional
            EmbeddingModelConfiguration = new EmbeddingModelConfigurationProperty {
                BedrockEmbeddingModelConfiguration = new BedrockEmbeddingModelConfigurationProperty {
                    Dimensions = 123,
                    EmbeddingDataType = "embeddingDataType"
                }
            },
            SupplementalDataStorageConfiguration = new SupplementalDataStorageConfigurationProperty {
                SupplementalDataStorageLocations = new [] { new SupplementalDataStorageLocationProperty {
                    SupplementalDataStorageLocationType = "supplementalDataStorageLocationType",

                    // the properties below are optional
                    S3Location = new S3LocationProperty {
                        Uri = "uri"
                    }
                } }
            }
        }
    },
    Name = "name",
    RoleArn = "roleArn",

    // the properties below are optional
    Description = "description",
    StorageConfiguration = new StorageConfigurationProperty {
        Type = "type",

        // the properties below are optional
        OpensearchServerlessConfiguration = new OpenSearchServerlessConfigurationProperty {
            CollectionArn = "collectionArn",
            FieldMapping = new OpenSearchServerlessFieldMappingProperty {
                MetadataField = "metadataField",
                TextField = "textField",
                VectorField = "vectorField"
            },
            VectorIndexName = "vectorIndexName"
        },
        PineconeConfiguration = new PineconeConfigurationProperty {
            ConnectionString = "connectionString",
            CredentialsSecretArn = "credentialsSecretArn",
            FieldMapping = new PineconeFieldMappingProperty {
                MetadataField = "metadataField",
                TextField = "textField"
            },

            // the properties below are optional
            Namespace = "namespace"
        },
        RdsConfiguration = new RdsConfigurationProperty {
            CredentialsSecretArn = "credentialsSecretArn",
            DatabaseName = "databaseName",
            FieldMapping = new RdsFieldMappingProperty {
                MetadataField = "metadataField",
                PrimaryKeyField = "primaryKeyField",
                TextField = "textField",
                VectorField = "vectorField"
            },
            ResourceArn = "resourceArn",
            TableName = "tableName"
        }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Constructors

CfnKnowledgeBaseProps()

Properties

Description

The description of the knowledge base associated with the inline agent.
KnowledgeBaseConfiguration

Contains details about the embeddings configuration of the knowledge base.
Name

The name of the knowledge base.
RoleArn

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
StorageConfiguration

Contains details about the storage configuration of the knowledge base.
Tags

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

Constructors

CfnKnowledgeBaseProps()

public CfnKnowledgeBaseProps()

Properties

Description

The description of the knowledge base associated with the inline agent.

public string Description { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description

KnowledgeBaseConfiguration

Contains details about the embeddings configuration of the knowledge base.

public object KnowledgeBaseConfiguration { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration

Name

The name of the knowledge base.

public string Name { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-name

RoleArn

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

public string RoleArn { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-rolearn

StorageConfiguration

Contains details about the storage configuration of the knowledge base.

public object StorageConfiguration { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-storageconfiguration

Tags

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

public IDictionary<string, string> Tags { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-tags

    Implements