CfnDatasetProps

class aws_cdk.aws_bedrockagentcore.CfnDatasetProps(*, dataset_name, schema_type, description=None, kms_key_arn=None, source=None, tags=None)

Bases: object

Properties for defining a CfnDataset.

Parameters:
  • dataset_name (str) – Human-readable name for the dataset. Unique within the account (case-insensitive). Immutable after creation.

  • schema_type (str) – Versioned schema type governing the structure of examples. Immutable after creation.

  • description (Optional[str]) – A description of the dataset.

  • kms_key_arn (Optional[str]) – Optional AWS KMS key ARN for SSE-KMS on service S3 writes.

  • source (Union[IResolvable, DataSourceTypeProperty, Dict[str, Any], None]) – Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to assign to the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

# examples: Any

cfn_dataset_props = bedrockagentcore.CfnDatasetProps(
    dataset_name="datasetName",
    schema_type="schemaType",

    # the properties below are optional
    description="description",
    kms_key_arn="kmsKeyArn",
    source=bedrockagentcore.CfnDataset.DataSourceTypeProperty(
        inline_examples=bedrockagentcore.CfnDataset.InlineExamplesSourceProperty(
            examples=[examples]
        ),
        s3_source=bedrockagentcore.CfnDataset.S3SourceProperty(
            s3_uri="s3Uri"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

dataset_name

Human-readable name for the dataset.

Unique within the account (case-insensitive). Immutable after creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-datasetname

description

A description of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-description

kms_key_arn

Optional AWS KMS key ARN for SSE-KMS on service S3 writes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-kmskeyarn

schema_type

Versioned schema type governing the structure of examples.

Immutable after creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-schematype

source

Source of initial examples.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-source

tags

A list of tags to assign to the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html#cfn-bedrockagentcore-dataset-tags