2.233.0

class CfnKnowledgeBaseLogsMixin

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBaseLogsMixin
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBaseLogsMixin
Javasoftware.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBaseLogsMixin
Pythonaws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBaseLogsMixin
TypeScript @aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBaseLogsMixin

Implements IMixin

Extends Mixin

Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.

  • Name – Specify a name for the knowledge base.

  • RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see Create a service role for Knowledge base for Amazon Bedrock .

  • KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required:

  • Type – Specify the value VECTOR .

  • StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required:

  • Type – Specify the vector store service that you are using.

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from '@aws-cdk/mixins-preview';
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';

declare const logsDelivery: logs.ILogsDelivery;
const cfnKnowledgeBaseLogsMixin = new bedrock_mixins.CfnKnowledgeBaseLogsMixin('logType', logsDelivery);

Initializer

new CfnKnowledgeBaseLogsMixin(logType: string, logDelivery: ILogsDelivery)

Parameters

  • logType string — Type of logs that are getting vended.
  • logDelivery ILogsDelivery — Object in charge of setting up the delivery source, delivery destination, and delivery connection.

Create a mixin to enable vended logs for AWS::Bedrock::KnowledgeBase.

Properties

NameTypeDescription
logDeliveryILogsDelivery
logTypestring
static APPLICATION_LOGSCfnKnowledgeBaseApplicationLogs
static RUNTIME_LOGSCfnKnowledgeBaseRuntimeLogs

logDelivery

Type: ILogsDelivery

logType

Type: string

static APPLICATION_LOGS

Type: CfnKnowledgeBaseApplicationLogs

static RUNTIME_LOGS

Type: CfnKnowledgeBaseRuntimeLogs

Methods

NameDescription
applyTo(resource)Apply vended logs configuration to the construct.
supports(construct)Check if this mixin supports the given construct (has vendedLogs property).

applyTo(resource)

public applyTo(resource: IConstruct): IConstruct

Parameters

Returns

Apply vended logs configuration to the construct.

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

Returns

  • boolean

Check if this mixin supports the given construct (has vendedLogs property).

← PreviousNext →