software.amazon.awscdk.services.sagemaker

Class CfnFeatureGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sagemaker.CfnFeatureGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:34.763Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFeatureGroup(Construct scope, java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A free form description of a `FeatureGroup` .
java.lang.String	getEventTimeFeatureName() The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` .
java.lang.Object	getFeatureDefinitions() A list of `Feature` s.
java.lang.String	getFeatureGroupName() The name of the `FeatureGroup` .
java.lang.Object	getOfflineStoreConfig() The configuration of an `OfflineStore` .
java.lang.Object	getOnlineStoreConfig() The configuration of an `OnlineStore` .
java.lang.String	getRecordIdentifierFeatureName() The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A free form description of a `FeatureGroup` .
void	setEventTimeFeatureName(java.lang.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(java.util.List<java.lang.Object> value) A list of `Feature` s.
void	setFeatureGroupName(java.lang.String value) The name of the `FeatureGroup` .
void	setOfflineStoreConfig(java.lang.Object value) The configuration of an `OfflineStore` .
void	setOnlineStoreConfig(java.lang.Object value) The configuration of an `OnlineStore` .
void	setRecordIdentifierFeatureName(java.lang.String value) The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` .
void	setRoleArn(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnFeatureGroup(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Tags used to define a `FeatureGroup` .

getEventTimeFeatureName

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

public void setEventTimeFeatureName(java.lang.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

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

public void setFeatureDefinitions(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

public void setFeatureDefinitions(java.util.List<java.lang.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

public java.lang.String getFeatureGroupName()

The name of the `FeatureGroup` .

setFeatureGroupName

public void setFeatureGroupName(java.lang.String value)

The name of the `FeatureGroup` .

getOfflineStoreConfig

public java.lang.Object getOfflineStoreConfig()

The configuration of an `OfflineStore` .

setOfflineStoreConfig

public void setOfflineStoreConfig(java.lang.Object value)

The configuration of an `OfflineStore` .

getOnlineStoreConfig

public java.lang.Object getOnlineStoreConfig()

The configuration of an `OnlineStore` .

setOnlineStoreConfig

public void setOnlineStoreConfig(java.lang.Object value)

The configuration of an `OnlineStore` .

getRecordIdentifierFeatureName

public java.lang.String getRecordIdentifierFeatureName()

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

setRecordIdentifierFeatureName

public void setRecordIdentifierFeatureName(java.lang.String value)

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

getDescription

public java.lang.String getDescription()

A free form description of a `FeatureGroup` .

setDescription

public void setDescription(java.lang.String value)

A free form description of a `FeatureGroup` .

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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