Skip to content
v2.274.0

CfnDatasetProps Struct ​

Properties for defining a CfnDataset.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';

declare const examples: any;
const cfnDatasetProps: bedrockagentcore.CfnDatasetProps = {
  datasetName: 'datasetName',
  schemaType: 'schemaType',

  // the properties below are optional
  description: 'description',
  kmsKeyArn: 'kmsKeyArn',
  source: {
    inlineExamples: {
      examples: [examples],
    },
    s3Source: {
      s3Uri: 's3Uri',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

datasetNamestringdataset_namestrdatasetNameStringDatasetNamestringDatasetName*stringrequired#
Human-readable name for the dataset.

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

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the dataset.
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#
Optional AWS KMS key ARN for SSE-KMS on service S3 writes.
schemaTypestringschema_typestrschemaTypeStringSchemaTypestringSchemaType*stringrequired#
Versioned schema type governing the structure of examples.

Immutable after creation.

sourceoptionalIResolvable | CfnDataset.DataSourceTypePropertysourceoptionaltyping.Union[IResolvable, DataSourceTypeProperty]sourceoptionalIResolvableSourceoptionalIResolvableSourceoptionalinterface{}#
Source of initial examples.

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

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to assign to the dataset.