Class CfnFeatureGroupProps
Properties for defining a CfnFeatureGroup
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFeatureGroupProps : Object, ICfnFeatureGroupProps
Syntax (vb)
Public Class CfnFeatureGroupProps
Inherits Object
Implements ICfnFeatureGroupProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var offlineStoreConfig;
var onlineStoreConfig;
var cfnFeatureGroupProps = new CfnFeatureGroupProps {
EventTimeFeatureName = "eventTimeFeatureName",
FeatureDefinitions = new [] { new FeatureDefinitionProperty {
FeatureName = "featureName",
FeatureType = "featureType"
} },
FeatureGroupName = "featureGroupName",
RecordIdentifierFeatureName = "recordIdentifierFeatureName",
// the properties below are optional
Description = "description",
OfflineStoreConfig = offlineStoreConfig,
OnlineStoreConfig = onlineStoreConfig,
RoleArn = "roleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ThroughputConfig = new ThroughputConfigProperty {
ThroughputMode = "throughputMode",
// the properties below are optional
ProvisionedReadCapacityUnits = 123,
ProvisionedWriteCapacityUnits = 123
}
};
Synopsis
Constructors
CfnFeatureGroupProps() |
Properties
Description | A free form description of a |
EventTimeFeatureName | The name of the feature that stores the |
FeatureDefinitions | A list of |
FeatureGroupName | The name of the |
OfflineStoreConfig | The configuration of an |
OnlineStoreConfig | The configuration of an |
RecordIdentifierFeatureName | The name of the |
RoleArn | The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. |
Tags | Tags used to define a |
ThroughputConfig | Used to set feature group throughput configuration. |
Constructors
CfnFeatureGroupProps()
public CfnFeatureGroupProps()
Properties
Description
A free form description of a FeatureGroup
.
public string Description { get; set; }
Property Value
System.String
Remarks
EventTimeFeatureName
The name of the feature that stores the EventTime
of a Record in a FeatureGroup
.
public string EventTimeFeatureName { get; set; }
Property Value
System.String
Remarks
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
A list of Feature
s. Each Feature
must include a FeatureName
and a FeatureType
.
public object FeatureDefinitions { get; set; }
Property Value
System.Object
Remarks
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
The name of the FeatureGroup
.
public string FeatureGroupName { get; set; }
Property Value
System.String
Remarks
OfflineStoreConfig
The configuration of an OfflineStore
.
public object OfflineStoreConfig { get; set; }
Property Value
System.Object
Remarks
OnlineStoreConfig
The configuration of an OnlineStore
.
public object OnlineStoreConfig { get; set; }
Property Value
System.Object
Remarks
RecordIdentifierFeatureName
The name of the Feature
whose value uniquely identifies a Record
defined in the FeatureGroup
FeatureDefinitions
.
public string RecordIdentifierFeatureName { get; set; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
Tags used to define a FeatureGroup
.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
ThroughputConfig
Used to set feature group throughput configuration.
public object ThroughputConfig { get; set; }
Property Value
System.Object
Remarks
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.