Class CfnKnowledgeBase
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
Inherited Members
Namespace: Amazon.CDK.AWS.Bedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnKnowledgeBase : CfnResource, IInspectable, IKnowledgeBaseRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Syntax (vb)
Public Class CfnKnowledgeBase Inherits CfnResource Implements IInspectable, IKnowledgeBaseRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::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.Bedrock;
var cfnKnowledgeBase = new CfnKnowledgeBase(this, "MyCfnKnowledgeBase", new CfnKnowledgeBaseProps {
KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
Type = "type",
// the properties below are optional
KendraKnowledgeBaseConfiguration = new KendraKnowledgeBaseConfigurationProperty {
KendraIndexArn = "kendraIndexArn"
},
ManagedKnowledgeBaseConfiguration = new ManagedKnowledgeBaseConfigurationProperty {
EmbeddingModelArn = "embeddingModelArn",
EmbeddingModelConfiguration = new EmbeddingModelConfigurationProperty {
BedrockEmbeddingModelConfiguration = new BedrockEmbeddingModelConfigurationProperty {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
EmbeddingModelType = "embeddingModelType",
ServerSideEncryptionConfiguration = new ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty {
KmsKeyArn = "kmsKeyArn"
}
},
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 {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
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
MongoDbAtlasConfiguration = new MongoDbAtlasConfigurationProperty {
CollectionName = "collectionName",
CredentialsSecretArn = "credentialsSecretArn",
DatabaseName = "databaseName",
Endpoint = "endpoint",
FieldMapping = new MongoDbAtlasFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName",
// the properties below are optional
EndpointServiceName = "endpointServiceName",
TextIndexName = "textIndexName"
},
NeptuneAnalyticsConfiguration = new NeptuneAnalyticsConfigurationProperty {
FieldMapping = new NeptuneAnalyticsFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField"
},
GraphArn = "graphArn"
},
OpensearchManagedClusterConfiguration = new OpenSearchManagedClusterConfigurationProperty {
DomainArn = "domainArn",
DomainEndpoint = "domainEndpoint",
FieldMapping = new OpenSearchManagedClusterFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName"
},
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",
// the properties below are optional
CustomMetadataField = "customMetadataField"
},
ResourceArn = "resourceArn",
TableName = "tableName"
},
S3VectorsConfiguration = new S3VectorsConfigurationProperty {
IndexArn = "indexArn",
IndexName = "indexName",
VectorBucketArn = "vectorBucketArn"
}
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});Synopsis
Constructors
| CfnKnowledgeBase(Construct, string, ICfnKnowledgeBaseProps) | Create a new |
Properties
| AttrCreatedAt | The time the knowledge base was created. |
| AttrFailureReasons | A list of reasons that the API operation on the knowledge base failed. |
| AttrKnowledgeBaseArn | The Amazon Resource Name (ARN) of the knowledge base. |
| AttrKnowledgeBaseId | The unique identifier for a knowledge base associated with the inline agent. |
| AttrStatus | The status of the knowledge base. |
| AttrUpdatedAt | The time the knowledge base was last updated. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CfnProperties | Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:. |
| CfnPropertyNames | Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:. |
| Description | The description of the knowledge base associated with the inline agent. |
| KnowledgeBaseConfiguration | Contains details about the embeddings configuration of the knowledge base. |
| KnowledgeBaseRef | A reference to a KnowledgeBase resource. |
| 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. |
Methods
| ArnForKnowledgeBase(IKnowledgeBaseRef) | Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:. |
| FromKnowledgeBaseArn(Construct, string, string) | Creates a new IKnowledgeBaseRef from an ARN. |
| FromKnowledgeBaseId(Construct, string, string) | Creates a new IKnowledgeBaseRef from a knowledgeBaseId. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnKnowledgeBase(object) | Checks whether the given object is a CfnKnowledgeBase. |
| RenderProperties(IDictionary<string, object>) | Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:. |
Constructors
CfnKnowledgeBase(Construct, string, ICfnKnowledgeBaseProps)
Create a new AWS::Bedrock::KnowledgeBase.
public CfnKnowledgeBase(Construct scope, string id, ICfnKnowledgeBaseProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnKnowledgeBaseProps
Resource properties.
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
Properties
AttrCreatedAt
The time the knowledge base was created.
public virtual string AttrCreatedAt { get; }Property Value
Remarks
CloudformationAttribute: CreatedAt
AttrFailureReasons
A list of reasons that the API operation on the knowledge base failed.
public virtual string[] AttrFailureReasons { get; }Property Value
string[]
Remarks
CloudformationAttribute: FailureReasons
AttrKnowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
public virtual string AttrKnowledgeBaseArn { get; }Property Value
Remarks
CloudformationAttribute: KnowledgeBaseArn
AttrKnowledgeBaseId
The unique identifier for a knowledge base associated with the inline agent.
public virtual string AttrKnowledgeBaseId { get; }Property Value
Remarks
CloudformationAttribute: KnowledgeBaseId
AttrStatus
The status of the knowledge base.
public virtual string AttrStatus { get; }Property Value
Remarks
CloudformationAttribute: Status
AttrUpdatedAt
The time the knowledge base was last updated.
public virtual string AttrUpdatedAt { get; }Property Value
Remarks
CloudformationAttribute: UpdatedAt
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
CfnProperties
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
CfnPropertyNames
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
protected override IDictionary<string, string> CfnPropertyNames { get; }Property Value
Overrides
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
Description
The description of the knowledge base associated with the inline agent.
public virtual string? Description { get; set; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
KnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
public virtual object KnowledgeBaseConfiguration { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnKnowledgeBase.IKnowledgeBaseConfigurationProperty
KnowledgeBaseRef
A reference to a KnowledgeBase resource.
public virtual IKnowledgeBaseReference KnowledgeBaseRef { get; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
Name
The name of the knowledge base.
public virtual string Name { get; set; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
RoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
public virtual string RoleArn { get; set; }Property Value
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
StorageConfiguration
Contains details about the storage configuration of the knowledge base.
public virtual object? StorageConfiguration { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnKnowledgeBase.IStorageConfigurationProperty
Tags
Metadata that you can assign to a resource as key-value pairs.
public virtual IDictionary<string, string>? Tags { get; set; }Property Value
Remarks
For more information, see the following resources:.
Methods
ArnForKnowledgeBase(IKnowledgeBaseRef)
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
public static string ArnForKnowledgeBase(IKnowledgeBaseRef resource)Parameters
- resource IKnowledgeBaseRef
Returns
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::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.Bedrock;
var cfnKnowledgeBase = new CfnKnowledgeBase(this, "MyCfnKnowledgeBase", new CfnKnowledgeBaseProps {
KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
Type = "type",
// the properties below are optional
KendraKnowledgeBaseConfiguration = new KendraKnowledgeBaseConfigurationProperty {
KendraIndexArn = "kendraIndexArn"
},
ManagedKnowledgeBaseConfiguration = new ManagedKnowledgeBaseConfigurationProperty {
EmbeddingModelArn = "embeddingModelArn",
EmbeddingModelConfiguration = new EmbeddingModelConfigurationProperty {
BedrockEmbeddingModelConfiguration = new BedrockEmbeddingModelConfigurationProperty {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
EmbeddingModelType = "embeddingModelType",
ServerSideEncryptionConfiguration = new ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty {
KmsKeyArn = "kmsKeyArn"
}
},
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 {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
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
MongoDbAtlasConfiguration = new MongoDbAtlasConfigurationProperty {
CollectionName = "collectionName",
CredentialsSecretArn = "credentialsSecretArn",
DatabaseName = "databaseName",
Endpoint = "endpoint",
FieldMapping = new MongoDbAtlasFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName",
// the properties below are optional
EndpointServiceName = "endpointServiceName",
TextIndexName = "textIndexName"
},
NeptuneAnalyticsConfiguration = new NeptuneAnalyticsConfigurationProperty {
FieldMapping = new NeptuneAnalyticsFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField"
},
GraphArn = "graphArn"
},
OpensearchManagedClusterConfiguration = new OpenSearchManagedClusterConfigurationProperty {
DomainArn = "domainArn",
DomainEndpoint = "domainEndpoint",
FieldMapping = new OpenSearchManagedClusterFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName"
},
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",
// the properties below are optional
CustomMetadataField = "customMetadataField"
},
ResourceArn = "resourceArn",
TableName = "tableName"
},
S3VectorsConfiguration = new S3VectorsConfigurationProperty {
IndexArn = "indexArn",
IndexName = "indexName",
VectorBucketArn = "vectorBucketArn"
}
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});FromKnowledgeBaseArn(Construct, string, string)
Creates a new IKnowledgeBaseRef from an ARN.
public static IKnowledgeBaseRef FromKnowledgeBaseArn(Construct scope, string id, string arn)Parameters
Returns
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
FromKnowledgeBaseId(Construct, string, string)
Creates a new IKnowledgeBaseRef from a knowledgeBaseId.
public static IKnowledgeBaseRef FromKnowledgeBaseId(Construct scope, string id, string knowledgeBaseId)Parameters
Returns
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
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.
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
IsCfnKnowledgeBase(object)
Checks whether the given object is a CfnKnowledgeBase.
public static bool IsCfnKnowledgeBase(object x)Parameters
- x object
Returns
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
CloudformationResource: AWS::Bedrock::KnowledgeBase
ExampleMetadata: fixture=_generated