CfnFeatureGroupProps
- class aws_cdk.aws_sagemaker.CfnFeatureGroupProps(*, event_time_feature_name, feature_definitions, feature_group_name, record_identifier_feature_name, description=None, offline_store_config=None, online_store_config=None, role_arn=None, tags=None)
Bases:
object
Properties for defining a
CfnFeatureGroup
.- Parameters:
event_time_feature_name (
str
) – The name of the feature that stores theEventTime
of a Record in aFeatureGroup
. AEventTime
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
.feature_definitions (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FeatureDefinitionProperty
,Dict
[str
,Any
]]]]) – A list ofFeature
s. EachFeature
must include aFeatureName
and aFeatureType
. ValidFeatureType
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,500FeatureDefinition
s perFeatureGroup
.feature_group_name (
str
) – The name of theFeatureGroup
.record_identifier_feature_name (
str
) – The name of theFeature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.description (
Optional
[str
]) – A free form description of aFeatureGroup
.offline_store_config (
Optional
[Any
]) – The configuration of anOfflineStore
.online_store_config (
Optional
[Any
]) – The configuration of anOnlineStore
.role_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Tags used to define aFeatureGroup
.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sagemaker as sagemaker # offline_store_config: Any # online_store_config: Any cfn_feature_group_props = sagemaker.CfnFeatureGroupProps( event_time_feature_name="eventTimeFeatureName", feature_definitions=[sagemaker.CfnFeatureGroup.FeatureDefinitionProperty( feature_name="featureName", feature_type="featureType" )], feature_group_name="featureGroupName", record_identifier_feature_name="recordIdentifierFeatureName", # the properties below are optional description="description", offline_store_config=offline_store_config, online_store_config=online_store_config, role_arn="roleArn", tags=[CfnTag( key="key", value="value" )] )
Attributes
- description
A free form description of a
FeatureGroup
.
- event_time_feature_name
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
.
- feature_definitions
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
.
- feature_group_name
The name of the
FeatureGroup
.
- offline_store_config
The configuration of an
OfflineStore
.
- online_store_config
The configuration of an
OnlineStore
.
- record_identifier_feature_name
The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.
- role_arn
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
- tags
Tags used to define a
FeatureGroup
.