software.amazon.awscdk.services.sagemaker

Class CfnFeatureGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnFeatureGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.897Z")
 @Stability(value=Stable)
public class CfnFeatureGroup
extends CfnResource
implements IInspectable

A CloudFormation `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.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup .

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;
 CfnFeatureGroup cfnFeatureGroup = CfnFeatureGroup.Builder.create(this, "MyCfnFeatureGroup")
         .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	Class and Description
static class	CfnFeatureGroup.Builder A fluent builder for CfnFeatureGroup.
static interface	CfnFeatureGroup.FeatureDefinitionProperty A list of features.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFeatureGroup(software.constructs.Construct scope, String id, CfnFeatureGroupProps props) Create a new `AWS::SageMaker::FeatureGroup`.
protected	CfnFeatureGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFeatureGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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` .
Object	getOfflineStoreConfig() The configuration of an `OfflineStore` .
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` .
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
TagManager	getTags() Tags used to define a `FeatureGroup` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A free form description of a `FeatureGroup` .
void	setEventTimeFeatureName(String value) The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` .
void	setFeatureDefinitions(IResolvable value) A list of `Feature` s.
void	setFeatureDefinitions(List<Object> value) A list of `Feature` s.
void	setFeatureGroupName(String value) The name of the `FeatureGroup` .
void	setOfflineStoreConfig(Object value) The configuration of an `OfflineStore` .
void	setOnlineStoreConfig(Object value) The configuration of an `OnlineStore` .
void	setRecordIdentifierFeatureName(String value) The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .
void	setRoleArn(String value) The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFeatureGroup

protected CfnFeatureGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnFeatureGroup

protected CfnFeatureGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFeatureGroup

@Stability(value=Stable)
public CfnFeatureGroup(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnFeatureGroupProps props)

Create a new `AWS::SageMaker::FeatureGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags used to define a `FeatureGroup` .

getEventTimeFeatureName

@Stability(value=Stable)
 @NotNull
public 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 .

setEventTimeFeatureName

@Stability(value=Stable)
public void setEventTimeFeatureName(@NotNull
                                                             String value)

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

setFeatureDefinitions

@Stability(value=Stable)
public void setFeatureDefinitions(@NotNull
                                                           IResolvable value)

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 .

setFeatureDefinitions

@Stability(value=Stable)
public void setFeatureDefinitions(@NotNull
                                                           List<Object> value)

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
public String getFeatureGroupName()

The name of the `FeatureGroup` .

setFeatureGroupName

@Stability(value=Stable)
public void setFeatureGroupName(@NotNull
                                                         String value)

The name of the `FeatureGroup` .

getOfflineStoreConfig

@Stability(value=Stable)
 @NotNull
public Object getOfflineStoreConfig()

The configuration of an `OfflineStore` .

setOfflineStoreConfig

@Stability(value=Stable)
public void setOfflineStoreConfig(@NotNull
                                                           Object value)

The configuration of an `OfflineStore` .

getOnlineStoreConfig

@Stability(value=Stable)
 @NotNull
public Object getOnlineStoreConfig()

The configuration of an `OnlineStore` .

setOnlineStoreConfig

@Stability(value=Stable)
public void setOnlineStoreConfig(@NotNull
                                                          Object value)

The configuration of an `OnlineStore` .

getRecordIdentifierFeatureName

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

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

setRecordIdentifierFeatureName

@Stability(value=Stable)
public void setRecordIdentifierFeatureName(@NotNull
                                                                    String value)

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

getDescription

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

A free form description of a `FeatureGroup` .

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A free form description of a `FeatureGroup` .

getRoleArn

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

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

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