interface CfnFeatureGroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnFeatureGroupProps`
Java	`software.amazon.awscdk.services.sagemaker.CfnFeatureGroupProps`
Python	`aws_cdk.aws_sagemaker.CfnFeatureGroupProps`
TypeScript	`@aws-cdk/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 * as sagemaker from '@aws-cdk/aws-sagemaker';

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

Name	Type	Description
eventTimeFeatureName	`string`	The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` .
featureDefinitions	`IResolvable` `\|` `IResolvable` `\|` `FeatureDefinitionProperty[]`	A list of `Feature` s. Each `Feature` must include a `FeatureName` and a `FeatureType` .
featureGroupName	`string`	The name of the `FeatureGroup` .
recordIdentifierFeatureName	`string`	The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .
description?	`string`	A free form description of a `FeatureGroup` .
offlineStoreConfig?	`any`	The configuration of an `OfflineStore` .
onlineStoreConfig?	`any`	The configuration of an `OnlineStore` .
roleArn?	`string`	The 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 .