Class: AWSCDK::Bedrock::CfnKnowledgeBase::S3VectorsConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_knowledge_base.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(index_arn: nil, index_name: nil, vector_bucket_arn: nil) ⇒ S3VectorsConfigurationProperty

Returns a new instance of S3VectorsConfigurationProperty.

Parameters:

  • index_arn (String, nil) (defaults to: nil) —

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

  • index_name (String, nil) (defaults to: nil) —

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

  • vector_bucket_arn (String, nil) (defaults to: nil) —

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



2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'bedrock/cfn_knowledge_base.rb', line 2479

def initialize(index_arn: nil, index_name: nil, vector_bucket_arn: nil)
  @index_arn = index_arn
  Jsii::Type.check_type(@index_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexArn") unless @index_arn.nil?
  @index_name = index_name
  Jsii::Type.check_type(@index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexName") unless @index_name.nil?
  @vector_bucket_arn = vector_bucket_arn
  Jsii::Type.check_type(@vector_bucket_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vectorBucketArn") unless @vector_bucket_arn.nil?
end

Instance Attribute Details

#index_arn ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2494
2495
2496
 
# File 'bedrock/cfn_knowledge_base.rb', line 2494

def index_arn
  @index_arn
end

#index_name ⇒ String? (readonly)

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

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

Returns:

  • (String, nil)

See Also:



2501
2502
2503
 
# File 'bedrock/cfn_knowledge_base.rb', line 2501

def index_name
  @index_name
end

#vector_bucket_arn ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2508
2509
2510
 
# File 'bedrock/cfn_knowledge_base.rb', line 2508

def vector_bucket_arn
  @vector_bucket_arn
end

Class Method Details

.jsii_properties ⇒ Object 



2510
2511
2512
2513
2514
2515
2516
 
# File 'bedrock/cfn_knowledge_base.rb', line 2510

def self.jsii_properties
  {
    :index_arn => "indexArn",
    :index_name => "indexName",
    :vector_bucket_arn => "vectorBucketArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2518
2519
2520
2521
2522
2523
2524
2525
2526
 
# File 'bedrock/cfn_knowledge_base.rb', line 2518

def to_jsii
  result = {}
  result.merge!({
    "indexArn" => @index_arn,
    "indexName" => @index_name,
    "vectorBucketArn" => @vector_bucket_arn,
  })
  result.compact
end