AWS::Bedrock::DataSource
Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:
-
Name – Specify a name for the data source.
-
KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to.
-
DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required:
-
Type – Specify the value
S3.
-
For more information about setting up data sources in Amazon Bedrock, see Set up a data source for your knowledge base.
See the Properties section below for descriptions of both the required and optional properties.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Bedrock::DataSource", "Properties" : { "DataDeletionPolicy" :String, "DataSourceConfiguration" :DataSourceConfiguration, "Description" :String, "KnowledgeBaseId" :String, "Name" :String, "ServerSideEncryptionConfiguration" :ServerSideEncryptionConfiguration, "VectorIngestionConfiguration" :VectorIngestionConfiguration} }
YAML
Type: AWS::Bedrock::DataSource Properties: DataDeletionPolicy:StringDataSourceConfiguration:DataSourceConfigurationDescription:StringKnowledgeBaseId:StringName:StringServerSideEncryptionConfiguration:ServerSideEncryptionConfigurationVectorIngestionConfiguration:VectorIngestionConfiguration
Properties
DataDeletionPolicy-
The deletion policy for the data source.
Required: No
Type: String
Allowed values:
RETAIN | DELETEUpdate requires: No interruption
DataSourceConfiguration-
Contains details about how the data source is stored.
Required: Yes
Type: DataSourceConfiguration
Update requires: No interruption
Description-
The description of the data source.
Required: No
Type: String
Minimum:
1Maximum:
200Update requires: No interruption
KnowledgeBaseId-
The unique identifier of the knowledge base to which the data source belongs.
Required: Yes
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Update requires: Replacement
Name-
The name of the data source.
Required: Yes
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Update requires: No interruption
ServerSideEncryptionConfiguration-
Contains details about the configuration of the server-side encryption.
Required: No
Type: ServerSideEncryptionConfiguration
Update requires: No interruption
VectorIngestionConfiguration-
Contains details about how to ingest the documents in the data source.
Required: No
Type: VectorIngestionConfiguration
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the knowledge base ID and the data source ID, separated by a pipe (|).
For example, { "Ref": "myDataSource" } could return the value "KB12345678|DS12345678".
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
CreatedAt-
The time at which the data source was created.
DataSourceId-
The unique identifier of the data source.
DataSourceStatus-
The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
-
FailureReasons-
The details of the failure reasons related to the data source.
UpdatedAt-
The time at which the data source was last updated.