Interface CfnKnowledgeBasePropsMixin.ISqlKnowledgeBaseConfigurationProperty

Contains configurations for a knowledge base connected to an SQL database.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnKnowledgeBasePropsMixin.ISqlKnowledgeBaseConfigurationProperty

Syntax (vb)

Public Interface CfnKnowledgeBasePropsMixin.ISqlKnowledgeBaseConfigurationProperty

Remarks

Specify the SQL database type in the type field and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.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.Mixins.Preview.AWS.Bedrock.Mixins;

             var sqlKnowledgeBaseConfigurationProperty = new SqlKnowledgeBaseConfigurationProperty {
                 RedshiftConfiguration = new RedshiftConfigurationProperty {
                     QueryEngineConfiguration = new RedshiftQueryEngineConfigurationProperty {
                         ProvisionedConfiguration = new RedshiftProvisionedConfigurationProperty {
                             AuthConfiguration = new RedshiftProvisionedAuthConfigurationProperty {
                                 DatabaseUser = "databaseUser",
                                 Type = "type",
                                 UsernamePasswordSecretArn = "usernamePasswordSecretArn"
                             },
                             ClusterIdentifier = "clusterIdentifier"
                         },
                         ServerlessConfiguration = new RedshiftServerlessConfigurationProperty {
                             AuthConfiguration = new RedshiftServerlessAuthConfigurationProperty {
                                 Type = "type",
                                 UsernamePasswordSecretArn = "usernamePasswordSecretArn"
                             },
                             WorkgroupArn = "workgroupArn"
                         },
                         Type = "type"
                     },
                     QueryGenerationConfiguration = new QueryGenerationConfigurationProperty {
                         ExecutionTimeoutSeconds = 123,
                         GenerationContext = new QueryGenerationContextProperty {
                             CuratedQueries = new [] { new CuratedQueryProperty {
                                 NaturalLanguage = "naturalLanguage",
                                 Sql = "sql"
                             } },
                             Tables = new [] { new QueryGenerationTableProperty {
                                 Columns = new [] { new QueryGenerationColumnProperty {
                                     Description = "description",
                                     Inclusion = "inclusion",
                                     Name = "name"
                                 } },
                                 Description = "description",
                                 Inclusion = "inclusion",
                                 Name = "name"
                             } }
                         }
                     },
                     StorageConfigurations = new [] { new RedshiftQueryEngineStorageConfigurationProperty {
                         AwsDataCatalogConfiguration = new RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty {
                             TableNames = new [] { "tableNames" }
                         },
                         RedshiftConfiguration = new RedshiftQueryEngineRedshiftStorageConfigurationProperty {
                             DatabaseName = "databaseName"
                         },
                         Type = "type"
                     } }
                 },
                 Type = "type"
             };

Synopsis

Properties

RedshiftConfiguration	Specifies configurations for a knowledge base connected to an Amazon Redshift database.
Type	The type of SQL database to connect to the knowledge base.

Properties

RedshiftConfiguration

Specifies configurations for a knowledge base connected to an Amazon Redshift database.

object? RedshiftConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration

Type union: either IResolvable or CfnKnowledgeBasePropsMixin.IRedshiftConfigurationProperty

Type

The type of SQL database to connect to the knowledge base.

string? Type { get; }

Property Value

string