CfnKnowledgeBaseLogsMixin

class aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBaseLogsMixin(log_type, log_delivery)

Bases: 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:

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

CloudformationResource:

AWS::Bedrock::KnowledgeBase

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import aws_logs as logs
from aws_cdk.mixins_preview.aws_bedrock import mixins as bedrock_mixins

# logs_delivery: logs.ILogsDelivery

cfn_knowledge_base_logs_mixin = bedrock_mixins.CfnKnowledgeBaseLogsMixin("logType", logs_delivery)

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

Parameters:

  • log_type (str) – Type of logs that are getting vended.

  • log_delivery (ILogsDelivery) – Object in charge of setting up the delivery destination and delivery connection.

Methods

apply_to(resource)

Apply vended logs configuration to the construct.

Parameters:

resource (IConstruct)

Return type:

IConstruct

supports(construct)

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

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

APPLICATION_LOGS = <aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBaseApplicationLogs object>
RUNTIME_LOGS = <aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBaseRuntimeLogs object>

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental