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

  • feature_definitions (Union[IResolvable, Sequence[Union[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 .

  • feature_group_name (str) – The name of the FeatureGroup .

  • record_identifier_feature_name (str) – The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .

  • description (Optional[str]) – A free form description of a FeatureGroup .

  • offline_store_config (Optional[Any]) – The configuration of an OfflineStore .

  • online_store_config (Optional[Any]) – The configuration of an OnlineStore .

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

  • tags (Optional[Sequence[CfnTag]]) – Tags used to define a FeatureGroup .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-description

Return type

Optional[str]

event_time_feature_name

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-eventtimefeaturename

Return type

str

feature_definitions

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuredefinitions

Return type

Union[IResolvable, List[Union[IResolvable, FeatureDefinitionProperty]]]

feature_group_name

The name of the FeatureGroup .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuregroupname

Return type

str

offline_store_config

The configuration of an OfflineStore .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-offlinestoreconfig

Return type

Any

online_store_config

The configuration of an OnlineStore .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-onlinestoreconfig

Return type

Any

record_identifier_feature_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-recordidentifierfeaturename

Return type

str

role_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-rolearn

Return type

Optional[str]

tags

Tags used to define a FeatureGroup .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-tags

Return type

Optional[List[CfnTag]]