Class CfnFeatureGroup
A CloudFormation AWS::SageMaker::FeatureGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnFeatureGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFeatureGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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
.
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var offlineStoreConfig;
var onlineStoreConfig;
var cfnFeatureGroup = new CfnFeatureGroup(this, "MyCfnFeatureGroup", new CfnFeatureGroupProps {
EventTimeFeatureName = "eventTimeFeatureName",
FeatureDefinitions = new [] { new FeatureDefinitionProperty {
FeatureName = "featureName",
FeatureType = "featureType"
} },
FeatureGroupName = "featureGroupName",
RecordIdentifierFeatureName = "recordIdentifierFeatureName",
// the properties below are optional
Description = "description",
OfflineStoreConfig = offlineStoreConfig,
OnlineStoreConfig = onlineStoreConfig,
RoleArn = "roleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnFeatureGroup(Construct, String, ICfnFeatureGroupProps) | Create a new |
CfnFeatureGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFeatureGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A free form description of a |
EventTimeFeatureName | The name of the feature that stores the |
FeatureDefinitions | A list of |
FeatureGroupName | The name of the |
OfflineStoreConfig | The configuration of an |
OnlineStoreConfig | The configuration of an |
RecordIdentifierFeatureName | The name of the |
RoleArn | The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. |
Tags | Tags used to define a |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFeatureGroup(Construct, String, ICfnFeatureGroupProps)
Create a new AWS::SageMaker::FeatureGroup
.
public CfnFeatureGroup(Construct scope, string id, ICfnFeatureGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFeatureGroupProps
- resource properties.
CfnFeatureGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFeatureGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFeatureGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFeatureGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A free form description of a FeatureGroup
.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EventTimeFeatureName
The name of the feature that stores the EventTime
of a Record in a FeatureGroup
.
public virtual string EventTimeFeatureName { get; set; }
Property Value
System.String
Remarks
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
.
FeatureDefinitions
A list of Feature
s. Each Feature
must include a FeatureName
and a FeatureType
.
public virtual object FeatureDefinitions { get; set; }
Property Value
System.Object
Remarks
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
.
FeatureGroupName
The name of the FeatureGroup
.
public virtual string FeatureGroupName { get; set; }
Property Value
System.String
Remarks
OfflineStoreConfig
The configuration of an OfflineStore
.
public virtual object OfflineStoreConfig { get; set; }
Property Value
System.Object
Remarks
OnlineStoreConfig
The configuration of an OnlineStore
.
public virtual object OnlineStoreConfig { get; set; }
Property Value
System.Object
Remarks
RecordIdentifierFeatureName
The name of the Feature
whose value uniquely identifies a Record
defined in the FeatureGroup
FeatureDefinitions
.
public virtual string RecordIdentifierFeatureName { get; set; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
Tags used to define a FeatureGroup
.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>