aws-cdk-lib.aws_sagemaker.CfnFeatureGroupProps

interface CfnFeatureGroupProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnFeatureGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnFeatureGroupProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnFeatureGroupProps
Pythonaws_cdk.aws_sagemaker.CfnFeatureGroupProps
TypeScript aws-cdk-lib » aws_sagemaker » CfnFeatureGroupProps

Properties for defining a CfnFeatureGroup.

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',
  }],
};

Properties

NameTypeDescription
eventTimeFeatureNamestringThe name of the feature that stores the EventTime of a Record in a FeatureGroup .
featureDefinitionsIResolvable | IResolvable | FeatureDefinitionProperty[]A list of Feature s. Each Feature must include a FeatureName and a FeatureType .
featureGroupNamestringThe name of the FeatureGroup .
recordIdentifierFeatureNamestringThe name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .
description?stringA free form description of a FeatureGroup .
offlineStoreConfig?anyThe configuration of an OfflineStore .
onlineStoreConfig?anyThe configuration of an OnlineStore .
roleArn?stringThe Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
tags?CfnTag[]Tags used to define a FeatureGroup .

eventTimeFeatureName

Type: 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 .


featureDefinitions

Type: 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 .


featureGroupName

Type: string

The name of the FeatureGroup .


recordIdentifierFeatureName

Type: string

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


description?

Type: string (optional)

A free form description of a FeatureGroup .


offlineStoreConfig?

Type: any (optional)

The configuration of an OfflineStore .


onlineStoreConfig?

Type: any (optional)

The configuration of an OnlineStore .


roleArn?

Type: string (optional)

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


tags?

Type: CfnTag[] (optional)

Tags used to define a FeatureGroup .