Package software.amazon.awscdk.services.sagemaker

Class CfnFeatureGroup

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.204Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFeatureGroup

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

    • CfnFeatureGroup

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

    • CfnFeatureGroup

      @Stability(Stable) public CfnFeatureGroup(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tags used to define a FeatureGroup .

    • getEventTimeFeatureName

      @Stability(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(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(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(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(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(Stable) @NotNull public String getFeatureGroupName()
      The name of the FeatureGroup .

    • setFeatureGroupName

      @Stability(Stable) public void setFeatureGroupName(@NotNull String value)
      The name of the FeatureGroup .

    • getOfflineStoreConfig

      @Stability(Stable) @NotNull public Object getOfflineStoreConfig()
      The configuration of an OfflineStore .

    • setOfflineStoreConfig

      @Stability(Stable) public void setOfflineStoreConfig(@NotNull Object value)
      The configuration of an OfflineStore .

    • getOnlineStoreConfig

      @Stability(Stable) @NotNull public Object getOnlineStoreConfig()
      The configuration of an OnlineStore .

    • setOnlineStoreConfig

      @Stability(Stable) public void setOnlineStoreConfig(@NotNull Object value)
      The configuration of an OnlineStore .

    • getRecordIdentifierFeatureName

      @Stability(Stable) @NotNull public String getRecordIdentifierFeatureName()
      The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .

    • setRecordIdentifierFeatureName

      @Stability(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(Stable) @Nullable public String getDescription()
      A free form description of a FeatureGroup .

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A free form description of a FeatureGroup .

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.