View a markdown version of this page

AWS::BedrockAgentCore::Dataset - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::Dataset

Specifies a dataset for Amazon Bedrock AgentCore. A dataset stores collections of examples used for agent evaluation, including inline examples or references to JSONL files in Amazon S3.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::BedrockAgentCore::Dataset", "Properties" : { "DatasetName" : String, "Description" : String, "KmsKeyArn" : String, "SchemaType" : String, "Source" : DataSourceType, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::BedrockAgentCore::Dataset Properties: DatasetName: String Description: String KmsKeyArn: String SchemaType: String Source: DataSourceType Tags: - Tag

Properties

DatasetName

Human-readable name for the dataset. Must be unique within the account. Immutable after creation.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$

Update requires: Replacement

Description

A description of the dataset.

Required: No

Type: String

Maximum: 200

Update requires: No interruption

KmsKeyArn

Optional AWS KMS key ARN for server-side encryption on service Amazon S3 writes.

Required: No

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Minimum: 1

Maximum: 2048

Update requires: Replacement

SchemaType

Versioned schema type governing the structure of examples. Immutable after creation.

Required: Yes

Type: String

Allowed values: AGENTCORE_EVALUATION_PREDEFINED_V1 | AGENTCORE_EVALUATION_SIMULATED_V1

Update requires: Replacement

Source

Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.

Required: No

Type: DataSourceType

Update requires: Replacement

Tags

A map of tag keys and values to assign to the dataset.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

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 timestamp when the dataset was created.

DatasetArn

Property description not available.

DatasetId

Property description not available.

ExampleCount

Property description not available.

Status

Property description not available.

UpdatedAt

The timestamp when the dataset was last updated.