Class: Aws::BedrockAgent::Types::CreateDataSourceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_deletion_policy ⇒ String

The data deletion policy for the data source.

You can set the data deletion policy to:

  • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

  • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

Returns:

  • (String) 


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_configuration ⇒ Types::DataSourceConfiguration

The connection configuration for the data source.

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the data source.

Returns:

  • (String) 


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base to which to add the data source.

Returns:

  • (String) 


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the data source.

Returns:

  • (String) 


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

Contains details about the server-side encryption for the data source.

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration

Contains details about how to ingest the documents in the data source.

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 1535

class CreateDataSourceRequest < Struct.new(
  :client_token,
  :data_deletion_policy,
  :data_source_configuration,
  :description,
  :knowledge_base_id,
  :name,
  :server_side_encryption_configuration,
  :vector_ingestion_configuration)
  SENSITIVE = []
  include Aws::Structure
end