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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.899Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getEventTimeFeatureName

@Stability(value=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 .

getFeatureDefinitions

@Stability(value=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 .

getFeatureGroupName

@Stability(value=Stable)
 @NotNull
String getFeatureGroupName()

The name of the `FeatureGroup` .

getRecordIdentifierFeatureName

@Stability(value=Stable)
 @NotNull
String getRecordIdentifierFeatureName()

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

getDescription

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

A free form description of a `FeatureGroup` .

getOfflineStoreConfig

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

The configuration of an `OfflineStore` .

getOnlineStoreConfig

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

The configuration of an `OnlineStore` .

getRoleArn

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

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

getTags

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

Tags used to define a `FeatureGroup` .

builder

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

Returns:

a CfnFeatureGroupProps.Builder of CfnFeatureGroupProps