Package software.amazon.awscdk.services.sagemaker

Interface CfnFeatureGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFeatureGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:13.413Z")
@Stability(Stable)
public interface CfnFeatureGroupProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.sagemaker.*;
 Object offlineStoreConfig;
 Object onlineStoreConfig;
 CfnFeatureGroupProps cfnFeatureGroupProps = CfnFeatureGroupProps.builder()
         .eventTimeFeatureName("eventTimeFeatureName")
         .featureDefinitions(List.of(FeatureDefinitionProperty.builder()
                 .featureName("featureName")
                 .featureType("featureType")
                 .build()))
         .featureGroupName("featureGroupName")
         .recordIdentifierFeatureName("recordIdentifierFeatureName")
         // the properties below are optional
         .description("description")
         .offlineStoreConfig(offlineStoreConfig)
         .onlineStoreConfig(onlineStoreConfig)
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFeatureGroupProps.Builder	A builder for CfnFeatureGroupProps
static final class	CfnFeatureGroupProps.Jsii$Proxy	An implementation for CfnFeatureGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnFeatureGroupProps.Builder	builder()
default String	getDescription()	A free form description of a FeatureGroup .
String	getEventTimeFeatureName()	The name of the feature that stores the EventTime of a Record in a FeatureGroup .
Object	getFeatureDefinitions()	A list of Feature s.
String	getFeatureGroupName()	The name of the FeatureGroup .
default Object	getOfflineStoreConfig()	The configuration of an OfflineStore .
default Object	getOnlineStoreConfig()	The configuration of an OnlineStore .
String	getRecordIdentifierFeatureName()	The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
default List<CfnTag>	getTags()	Tags used to define a FeatureGroup .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventTimeFeatureName

@Stability(Stable)
@NotNull
String getEventTimeFeatureName()

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 .

See Also:

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

getFeatureDefinitions

@Stability(Stable)
@NotNull
Object getFeatureDefinitions()

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 .

See Also:

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

getFeatureGroupName

@Stability(Stable)
@NotNull
String getFeatureGroupName()

The name of the FeatureGroup .

See Also:

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

getRecordIdentifierFeatureName

@Stability(Stable)
@NotNull
String getRecordIdentifierFeatureName()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A free form description of a FeatureGroup .

See Also:

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

getOfflineStoreConfig

@Stability(Stable)
@Nullable
default Object getOfflineStoreConfig()

The configuration of an OfflineStore .

See Also:

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

getOnlineStoreConfig

@Stability(Stable)
@Nullable
default Object getOnlineStoreConfig()

The configuration of an OnlineStore .

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags used to define a FeatureGroup .

See Also:

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

builder

@Stability(Stable)
static CfnFeatureGroupProps.Builder builder()

Returns:

a CfnFeatureGroupProps.Builder of CfnFeatureGroupProps