Class CfnFeatureGroup
Create a new FeatureGroup .
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFeatureGroup : CfnResource, IInspectable, IFeatureGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnFeatureGroup Inherits CfnResource Implements IInspectable, IFeatureGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
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"
} },
ThroughputConfig = new ThroughputConfigProperty {
ThroughputMode = "throughputMode",
// the properties below are optional
ProvisionedReadCapacityUnits = 123,
ProvisionedWriteCapacityUnits = 123
}
});
Synopsis
Constructors
| CfnFeatureGroup(Construct, string, ICfnFeatureGroupProps) | Create a new |
Properties
| AttrCreationTime | The time a |
| AttrFeatureGroupStatus | A |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Create a new |
| 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 |
| FeatureGroupRef | A reference to a FeatureGroup resource. |
| 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 | Tag Manager which manages the tags for this resource. |
| TagsRaw | Tags used to define a |
| ThroughputConfig | Used to set feature group throughput configuration. |
Methods
| ArnForFeatureGroup(IFeatureGroupRef) | Create a new |
| FromFeatureGroupName(Construct, string, string) | Creates a new IFeatureGroupRef from a featureGroupName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnFeatureGroup(object) | Checks whether the given object is a CfnFeatureGroup. |
| RenderProperties(IDictionary<string, object>) | Create a new |
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 string
Construct identifier for this resource (unique in its scope).
- props ICfnFeatureGroupProps
Resource properties.
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
Properties
AttrCreationTime
The time a FeatureGroup was created.
public virtual string AttrCreationTime { get; }
Property Value
Remarks
CloudformationAttribute: CreationTime
AttrFeatureGroupStatus
A FeatureGroup status.
public virtual string AttrFeatureGroupStatus { get; }
Property Value
Remarks
CloudformationAttribute: FeatureGroupStatus
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
CfnProperties
Create a new FeatureGroup .
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
Description
A free form description of a FeatureGroup .
public virtual string? Description { get; set; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
EventTimeFeatureName
The name of the feature that stores the EventTime of a Record in a FeatureGroup .
public virtual string EventTimeFeatureName { get; set; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
FeatureDefinitions
A list of Feature s.
public virtual object FeatureDefinitions { get; set; }
Property Value
Remarks
Each Feature must include a FeatureName and a FeatureType .
Type union: either IResolvable or (either IResolvable or CfnFeatureGroup.IFeatureDefinitionProperty)[]
FeatureGroupName
The name of the FeatureGroup .
public virtual string FeatureGroupName { get; set; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
FeatureGroupRef
A reference to a FeatureGroup resource.
public virtual IFeatureGroupReference FeatureGroupRef { get; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
OfflineStoreConfig
The configuration of an OfflineStore .
public virtual object? OfflineStoreConfig { get; set; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
OnlineStoreConfig
The configuration of an OnlineStore .
public virtual object? OnlineStoreConfig { get; set; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
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
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
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
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
TagsRaw
Tags used to define a FeatureGroup .
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
ThroughputConfig
Used to set feature group throughput configuration.
public virtual object? ThroughputConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFeatureGroup.IThroughputConfigProperty
Methods
ArnForFeatureGroup(IFeatureGroupRef)
Create a new FeatureGroup .
public static string ArnForFeatureGroup(IFeatureGroupRef resource)
Parameters
- resource IFeatureGroupRef
Returns
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
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"
} },
ThroughputConfig = new ThroughputConfigProperty {
ThroughputMode = "throughputMode",
// the properties below are optional
ProvisionedReadCapacityUnits = 123,
ProvisionedWriteCapacityUnits = 123
}
});
FromFeatureGroupName(Construct, string, string)
Creates a new IFeatureGroupRef from a featureGroupName.
public static IFeatureGroupRef FromFeatureGroupName(Construct scope, string id, string featureGroupName)
Parameters
Returns
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
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.
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
IsCfnFeatureGroup(object)
Checks whether the given object is a CfnFeatureGroup.
public static bool IsCfnFeatureGroup(object x)
Parameters
- x object
Returns
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Create a new FeatureGroup .
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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 <code>OnlineStoreConfig</code> and <code>OfflineStoreConfig</code> to create a <code>FeatureGroup</code> .
CloudformationResource: AWS::SageMaker::FeatureGroup
ExampleMetadata: fixture=_generated