Class: AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterConfigurationProperty

Defined in:

bedrock/cfn_knowledge_base.rb

Overview

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

For more information, see Create a vector index in OpenSearch Managed Cluster .

See Also:

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

Instance Attribute Summary

• #domain_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the OpenSearch domain.

• #domain_endpoint ⇒ String readonly

  The endpoint URL the OpenSearch domain.

• #field_mapping ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterFieldMappingProperty readonly

  Contains the names of the fields to which to map information about the vector store.

• #vector_index_name ⇒ String readonly

  The name of the vector store.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(domain_arn:, domain_endpoint:, field_mapping:, vector_index_name:) ⇒ OpenSearchManagedClusterConfigurationProperty constructor

  A new instance of OpenSearchManagedClusterConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(domain_arn:, domain_endpoint:, field_mapping:, vector_index_name:) ⇒ OpenSearchManagedClusterConfigurationProperty

Returns a new instance of OpenSearchManagedClusterConfigurationProperty.

Parameters:

• domain_arn (String) —

  The Amazon Resource Name (ARN) of the OpenSearch domain.

• domain_endpoint (String) —

  The endpoint URL the OpenSearch domain.

• field_mapping (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterFieldMappingProperty) —

  Contains the names of the fields to which to map information about the vector store.

• vector_index_name (String) —

  The name of the vector store.

# File 'bedrock/cfn_knowledge_base.rb', line 1334

def initialize(domain_arn:, domain_endpoint:, field_mapping:, vector_index_name:)
  @domain_arn = domain_arn
  Jsii::Type.check_type(@domain_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainArn")
  @domain_endpoint = domain_endpoint
  Jsii::Type.check_type(@domain_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainEndpoint")
  @field_mapping = field_mapping.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterFieldMappingProperty.new(**field_mapping.transform_keys(&:to_sym)) : field_mapping
  Jsii::Type.check_type(@field_mapping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuT3BlblNlYXJjaE1hbmFnZWRDbHVzdGVyRmllbGRNYXBwaW5nUHJvcGVydHkifV19fQ==")), "fieldMapping")
  @vector_index_name = vector_index_name
  Jsii::Type.check_type(@vector_index_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vectorIndexName")
end

Instance Attribute Details

#domain_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the OpenSearch domain.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1349

def domain_arn
  @domain_arn
end

#domain_endpoint ⇒ String (readonly)

The endpoint URL the OpenSearch domain.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1354

def domain_endpoint
  @domain_endpoint
end

#field_mapping ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterFieldMappingProperty (readonly)

Contains the names of the fields to which to map information about the vector store.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchManagedClusterFieldMappingProperty)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1359

def field_mapping
  @field_mapping
end

#vector_index_name ⇒ String (readonly)

The name of the vector store.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1364

def vector_index_name
  @vector_index_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1366

def self.jsii_properties
  {
    :domain_arn => "domainArn",
    :domain_endpoint => "domainEndpoint",
    :field_mapping => "fieldMapping",
    :vector_index_name => "vectorIndexName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1375

def to_jsii
  result = {}
  result.merge!({
    "domainArn" => @domain_arn,
    "domainEndpoint" => @domain_endpoint,
    "fieldMapping" => @field_mapping,
    "vectorIndexName" => @vector_index_name,
  })
  result.compact
end