Class: AWSCDK::Bedrock::CfnKnowledgeBaseProps

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

Overview

Properties for defining a CfnKnowledgeBase.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(knowledge_base_configuration:, name:, role_arn:, description: nil, storage_configuration: nil, tags: nil) ⇒ CfnKnowledgeBaseProps

Returns a new instance of CfnKnowledgeBaseProps.

Parameters:

  • knowledge_base_configuration (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::KnowledgeBaseConfigurationProperty) —

    Contains details about the embeddings configuration of the knowledge base.

  • name (String) —

    The name of the knowledge base.

  • role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

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

    The description of the knowledge base associated with the inline agent.

  • storage_configuration (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::StorageConfigurationProperty, nil) (defaults to: nil) —

    Contains details about the storage configuration of the knowledge base.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 15

def initialize(knowledge_base_configuration:, name:, role_arn:, description: nil, storage_configuration: nil, tags: nil)
  @knowledge_base_configuration = knowledge_base_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::KnowledgeBaseConfigurationProperty.new(**knowledge_base_configuration.transform_keys(&:to_sym)) : knowledge_base_configuration
  Jsii::Type.check_type(@knowledge_base_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuS25vd2xlZGdlQmFzZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "knowledgeBaseConfiguration")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @storage_configuration = storage_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnKnowledgeBase::StorageConfigurationProperty.new(**storage_configuration.transform_keys(&:to_sym)) : storage_configuration
  Jsii::Type.check_type(@storage_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbktub3dsZWRnZUJhc2UuU3RvcmFnZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "storageConfiguration") unless @storage_configuration.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the knowledge base associated with the inline agent.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 49

def description
  @description
end

#knowledge_base_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::KnowledgeBaseConfigurationProperty (readonly)

Contains details about the embeddings configuration of the knowledge base.

Returns:

See Also:



34
35
36
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 34

def knowledge_base_configuration
  @knowledge_base_configuration
end

#name ⇒ String (readonly)

The name of the knowledge base.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 39

def name
  @name
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 44

def role_arn
  @role_arn
end

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

Contains details about the storage configuration of the knowledge base.

Returns:

See Also:



54
55
56
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 54

def storage_configuration
  @storage_configuration
end

#tags ⇒ Hash{String => String}? (readonly)

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

Returns:

  • (Hash{String => String}, nil)

See Also:



62
63
64
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 62

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 64

def self.jsii_properties
  {
    :knowledge_base_configuration => "knowledgeBaseConfiguration",
    :name => "name",
    :role_arn => "roleArn",
    :description => "description",
    :storage_configuration => "storageConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'bedrock/cfn_knowledge_base_props.rb', line 75

def to_jsii
  result = {}
  result.merge!({
    "knowledgeBaseConfiguration" => @knowledge_base_configuration,
    "name" => @name,
    "roleArn" => @role_arn,
    "description" => @description,
    "storageConfiguration" => @storage_configuration,
    "tags" => @tags,
  })
  result.compact
end