AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SageMaker::FeatureGroup

CfnFeatureGroup

Create a new `FeatureGroup` . A `FeatureGroup` is a group of `Features` defined in the `FeatureStore` to describe a `Record` . The `FeatureGroup` defines the schema and features contained in the FeatureGroup. A `FeatureGroup` definition is composed of a list of `Features` , a `RecordIdentifierFeatureName` , an `EventTimeFeatureName` and configurations for its `OnlineStore` and `OfflineStore` . Check [AWS service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to see the `FeatureGroup` s quota for your AWS account. > You must include at least one of `OnlineStoreConfig` and `OfflineStoreConfig` to create a `FeatureGroup` .

Import

import { CfnFeatureGroup } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnFeatureGroup

Properties

Configuration passed to the constructor as CfnFeatureGroupProps.

eventTimeFeatureNameRequired
string

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` .

featureDefinitionsRequired
IResolvable | IResolvable | FeatureDefinitionProperty[]

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` .

featureGroupNameRequired
string

The name of the `FeatureGroup` .

recordIdentifierFeatureNameRequired
string

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

descriptionOptional
string

A free form description of a `FeatureGroup` .

offlineStoreConfigOptional
any

The configuration of an `OfflineStore` .

onlineStoreConfigOptional
any

The configuration of an `OnlineStore` .

roleArnOptional
string | IRoleRef

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

tagsOptional
CfnTag[]

Tags used to define a `FeatureGroup` .

throughputConfigOptional
IResolvable | ThroughputConfigProperty

Used to set feature group throughput configuration. 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`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter