Class: AWSCDK::Bedrock::CfnKnowledgeBase::StorageConfigurationProperty

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

Overview

Contains the storage configuration of the knowledge base.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, mongo_db_atlas_configuration: nil, neptune_analytics_configuration: nil, opensearch_managed_cluster_configuration: nil, opensearch_serverless_configuration: nil, pinecone_configuration: nil, rds_configuration: nil, s3_vectors_configuration: nil) ⇒ StorageConfigurationProperty

Returns a new instance of StorageConfigurationProperty.

Parameters:



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'bedrock/cfn_knowledge_base.rb', line 2588

def initialize(type:, mongo_db_atlas_configuration: nil, neptune_analytics_configuration: nil, opensearch_managed_cluster_configuration: nil, opensearch_serverless_configuration: nil, pinecone_configuration: nil, rds_configuration: nil, s3_vectors_configuration: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @mongo_db_atlas_configuration = mongo_db_atlas_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::MongoDBAtlasConfigurationProperty.new(**mongo_db_atlas_configuration.transform_keys(&:to_sym)) : mongo_db_atlas_configuration
  Jsii::Type.check_type(@mongo_db_atlas_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuTW9uZ29EYkF0bGFzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "mongoDbAtlasConfiguration") unless @mongo_db_atlas_configuration.nil?
  @neptune_analytics_configuration = neptune_analytics_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::NeptuneAnalyticsConfigurationProperty.new(**neptune_analytics_configuration.transform_keys(&:to_sym)) : neptune_analytics_configuration
  Jsii::Type.check_type(@neptune_analytics_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuTmVwdHVuZUFuYWx5dGljc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "neptuneAnalyticsConfiguration") unless @neptune_analytics_configuration.nil?
  @opensearch_managed_cluster_configuration = opensearch_managed_cluster_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterConfigurationProperty.new(**opensearch_managed_cluster_configuration.transform_keys(&:to_sym)) : opensearch_managed_cluster_configuration
  Jsii::Type.check_type(@opensearch_managed_cluster_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuT3BlblNlYXJjaE1hbmFnZWRDbHVzdGVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "opensearchManagedClusterConfiguration") unless @opensearch_managed_cluster_configuration.nil?
  @opensearch_serverless_configuration = opensearch_serverless_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessConfigurationProperty.new(**opensearch_serverless_configuration.transform_keys(&:to_sym)) : opensearch_serverless_configuration
  Jsii::Type.check_type(@opensearch_serverless_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuT3BlblNlYXJjaFNlcnZlcmxlc3NDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "opensearchServerlessConfiguration") unless @opensearch_serverless_configuration.nil?
  @pinecone_configuration = pinecone_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::PineconeConfigurationProperty.new(**pinecone_configuration.transform_keys(&:to_sym)) : pinecone_configuration
  Jsii::Type.check_type(@pinecone_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuUGluZWNvbmVDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "pineconeConfiguration") unless @pinecone_configuration.nil?
  @rds_configuration = rds_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::RDSConfigurationProperty.new(**rds_configuration.transform_keys(&:to_sym)) : rds_configuration
  Jsii::Type.check_type(@rds_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuUmRzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "rdsConfiguration") unless @rds_configuration.nil?
  @s3_vectors_configuration = s3_vectors_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::S3VectorsConfigurationProperty.new(**s3_vectors_configuration.transform_keys(&:to_sym)) : s3_vectors_configuration
  Jsii::Type.check_type(@s3_vectors_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuUzNWZWN0b3JzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "s3VectorsConfiguration") unless @s3_vectors_configuration.nil?
end

Instance Attribute Details

#mongo_db_atlas_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains the storage configuration of the knowledge base in MongoDB Atlas.

Returns:

See Also:



2616
2617
2618
 
# File 'bedrock/cfn_knowledge_base.rb', line 2616

def mongo_db_atlas_configuration
  @mongo_db_atlas_configuration
end

#neptune_analytics_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune.

For more information, see Create a vector index in Amazon Neptune Analytics. .

Returns:

See Also:



2623
2624
2625
 
# File 'bedrock/cfn_knowledge_base.rb', line 2623

def neptune_analytics_configuration
  @neptune_analytics_configuration
end

#opensearch_managed_cluster_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster.

For more information, see Create a vector index in Amazon OpenSearch Service .

Returns:

See Also:



2630
2631
2632
 
# File 'bedrock/cfn_knowledge_base.rb', line 2630

def opensearch_managed_cluster_configuration
  @opensearch_managed_cluster_configuration
end

#opensearch_serverless_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

Returns:

See Also:



2635
2636
2637
 
# File 'bedrock/cfn_knowledge_base.rb', line 2635

def opensearch_serverless_configuration
  @opensearch_serverless_configuration
end

#pinecone_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains the storage configuration of the knowledge base in Pinecone.

Returns:

See Also:



2640
2641
2642
 
# File 'bedrock/cfn_knowledge_base.rb', line 2640

def pinecone_configuration
  @pinecone_configuration
end

#rds_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains details about the storage configuration of the knowledge base in Amazon RDS.

For more information, see Create a vector index in Amazon RDS .

Returns:

See Also:



2647
2648
2649
 
# File 'bedrock/cfn_knowledge_base.rb', line 2647

def rds_configuration
  @rds_configuration
end

#s3_vectors_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration settings for storing knowledge base data using S3 vectors.

This includes vector index information and S3 bucket details for vector storage.

Returns:

See Also:



2654
2655
2656
 
# File 'bedrock/cfn_knowledge_base.rb', line 2654

def s3_vectors_configuration
  @s3_vectors_configuration
end

#type ⇒ String (readonly)

The vector store service in which the knowledge base is stored.

Returns:

  • (String)

See Also:



2611
2612
2613
 
# File 'bedrock/cfn_knowledge_base.rb', line 2611

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
 
# File 'bedrock/cfn_knowledge_base.rb', line 2656

def self.jsii_properties
  {
    :type => "type",
    :mongo_db_atlas_configuration => "mongoDbAtlasConfiguration",
    :neptune_analytics_configuration => "neptuneAnalyticsConfiguration",
    :opensearch_managed_cluster_configuration => "opensearchManagedClusterConfiguration",
    :opensearch_serverless_configuration => "opensearchServerlessConfiguration",
    :pinecone_configuration => "pineconeConfiguration",
    :rds_configuration => "rdsConfiguration",
    :s3_vectors_configuration => "s3VectorsConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
 
# File 'bedrock/cfn_knowledge_base.rb', line 2669

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "mongoDbAtlasConfiguration" => @mongo_db_atlas_configuration,
    "neptuneAnalyticsConfiguration" => @neptune_analytics_configuration,
    "opensearchManagedClusterConfiguration" => @opensearch_managed_cluster_configuration,
    "opensearchServerlessConfiguration" => @opensearch_serverless_configuration,
    "pineconeConfiguration" => @pinecone_configuration,
    "rdsConfiguration" => @rds_configuration,
    "s3VectorsConfiguration" => @s3_vectors_configuration,
  })
  result.compact
end