AWS::SageMaker::FeatureGroup
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 to see the FeatureGroup
s quota
for your AWS account.
Important
You must include at least one of OnlineStoreConfig
and
OfflineStoreConfig
to create a FeatureGroup
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SageMaker::FeatureGroup", "Properties" : { "Description" :
String
, "EventTimeFeatureName" :String
, "FeatureDefinitions" :[ FeatureDefinition, ... ]
, "FeatureGroupName" :String
, "OfflineStoreConfig" :OfflineStoreConfig
, "OnlineStoreConfig" :OnlineStoreConfig
, "RecordIdentifierFeatureName" :String
, "RoleArn" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::SageMaker::FeatureGroup Properties: Description:
String
EventTimeFeatureName:String
FeatureDefinitions:- FeatureDefinition
FeatureGroupName:String
OfflineStoreConfig:OfflineStoreConfig
OnlineStoreConfig:OnlineStoreConfig
RecordIdentifierFeatureName:String
RoleArn:String
Tags:- Tag
Properties
Description
-
A free form description of a
FeatureGroup
.Required: No
Type: String
Maximum:
128
Update requires: Replacement
EventTimeFeatureName
-
The name of the feature that stores the
EventTime
of a Record in aFeatureGroup
.A
EventTime
is point in time when a new event occurs that corresponds to the creation or update of aRecord
inFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}
Minimum:
1
Maximum:
64
Update requires: Replacement
FeatureDefinitions
-
A list of
Feature
s. EachFeature
must include aFeatureName
and aFeatureType
.Valid
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.Required: Yes
Type: Array of FeatureDefinition
Minimum:
1
Maximum:
2500
Update requires: No interruption
FeatureGroupName
-
The name of the
FeatureGroup
.Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}
Minimum:
1
Maximum:
64
Update requires: Replacement
OfflineStoreConfig
-
The configuration of an
OfflineStore
.Required: No
Type: OfflineStoreConfig
Update requires: Replacement
OnlineStoreConfig
-
The configuration of an
OnlineStore
.Required: No
Type: OnlineStoreConfig
Update requires: Replacement
RecordIdentifierFeatureName
-
The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}
Minimum:
1
Maximum:
64
Update requires: Replacement
RoleArn
-
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
Required: No
Type: String
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Minimum:
20
Maximum:
2048
Update requires: Replacement
-
Tags used to define a
FeatureGroup
.Required: No
Type: Array of Tag
Maximum:
50
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the FeatureGroupName
of the feature
group.
Fn::GetAtt
CreationTime
-
The time a
FeatureGroup
was created. FeatureGroupStatus
-
A
FeatureGroup
status.