aws-cdk-lib.aws_sagemaker.CfnFeatureGroupProps

CfnFeatureGroupProps Struct

Properties for defining a CfnFeatureGroup.

CfnFeatureGroupProps

used as props by

• CfnFeatureGroup

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

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

declare const offlineStoreConfig: any;
declare const onlineStoreConfig: any;
const cfnFeatureGroupProps: sagemaker.CfnFeatureGroupProps = {
  eventTimeFeatureName: 'eventTimeFeatureName',
  featureDefinitions: [{
    featureName: 'featureName',
    featureType: 'featureType',
  }],
  featureGroupName: 'featureGroupName',
  recordIdentifierFeatureName: 'recordIdentifierFeatureName',

  // the properties below are optional
  description: 'description',
  offlineStoreConfig: offlineStoreConfig,
  onlineStoreConfig: onlineStoreConfig,
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  throughputConfig: {
    throughputMode: 'throughputMode',

    // the properties below are optional
    provisionedReadCapacityUnits: 123,
    provisionedWriteCapacityUnits: 123,
  },
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A free form description of a `FeatureGroup` .

eventTimeFeatureNamestringevent_time_feature_namestreventTimeFeatureNameStringEventTimeFeatureNamestringEventTimeFeatureName*stringrequired#

The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` .

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup . All Records in the FeatureGroup must have a corresponding EventTime .

featureDefinitionsIResolvable | IResolvable | CfnFeatureGroup.FeatureDefinitionProperty[]feature_definitionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FeatureDefinitionProperty]]]featureDefinitionsIResolvableFeatureDefinitionsIResolvableFeatureDefinitionsinterface{}required#

A list of `Feature` s. Each `Feature` must include a `FeatureName` and a `FeatureType` .

Valid FeatureType s are Integral , Fractional and String .

FeatureName s cannot be any of the following: is_deleted , write_time , api_invocation_time .

You can create up to 2,500 FeatureDefinition s per FeatureGroup .

featureGroupNamestringfeature_group_namestrfeatureGroupNameStringFeatureGroupNamestringFeatureGroupName*stringrequired#

The name of the `FeatureGroup` .

offlineStoreConfiganyoffline_store_configAnyofflineStoreConfigObjectOfflineStoreConfigobjectOfflineStoreConfiginterface{}#

The configuration of an `OfflineStore` .

onlineStoreConfiganyonline_store_configAnyonlineStoreConfigObjectOnlineStoreConfigobjectOnlineStoreConfiginterface{}#

The configuration of an `OnlineStore` .

recordIdentifierFeatureNamestringrecord_identifier_feature_namestrrecordIdentifierFeatureNameStringRecordIdentifierFeatureNamestringRecordIdentifierFeatureName*stringrequired#

The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .

roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}#

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Tags used to define a `FeatureGroup` .

throughputConfigIResolvable | CfnFeatureGroup.ThroughputConfigPropertythroughput_configtyping.Union[IResolvable, ThroughputConfigProperty]throughputConfigIResolvableThroughputConfigIResolvableThroughputConfiginterface{}#

Used to set feature group throughput configuration.

notes

There are two modes: ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.