Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.S3VectorsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.S3VectorsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.S3VectorsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains the storage configuration of the knowledge base for S3 vectors.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 S3VectorsConfigurationProperty s3VectorsConfigurationProperty = S3VectorsConfigurationProperty.builder()
         .indexArn("indexArn")
         .indexName("indexName")
         .vectorBucketArn("vectorBucketArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBase.S3VectorsConfigurationProperty.Builder	A builder for CfnKnowledgeBase.S3VectorsConfigurationProperty
static final class	CfnKnowledgeBase.S3VectorsConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBase.S3VectorsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.S3VectorsConfigurationProperty.Builder	builder()
default String	getIndexArn()	The Amazon Resource Name (ARN) of the vector index used for the knowledge base.
default String	getIndexName()	The name of the vector index used for the knowledge base.
default String	getVectorBucketArn()	The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexArn

@Stability(Stable)
@Nullable
default String getIndexArn()

The Amazon Resource Name (ARN) of the vector index used for the knowledge base.

This ARN identifies the specific vector index resource within Amazon Bedrock.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexarn

getIndexName

@Stability(Stable)
@Nullable
default String getIndexName()

The name of the vector index used for the knowledge base.

This name identifies the vector index within the Amazon Bedrock service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexname

getVectorBucketArn

@Stability(Stable)
@Nullable
default String getVectorBucketArn()

The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored.

This bucket contains the vector data used by the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.html#cfn-bedrock-knowledgebase-s3vectorsconfiguration-vectorbucketarn

builder

@Stability(Stable)
static CfnKnowledgeBase.S3VectorsConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBase.S3VectorsConfigurationProperty.Builder of CfnKnowledgeBase.S3VectorsConfigurationProperty