class CfnFeatureGroup (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Sagemaker.CfnFeatureGroup |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnFeatureGroup |
![]() | software.amazon.awscdk.services.sagemaker.CfnFeatureGroup |
![]() | aws_cdk.aws_sagemaker.CfnFeatureGroup |
![]() | aws-cdk-lib » aws_sagemaker » CfnFeatureGroup |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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
andOfflineStoreConfig
to create aFeatureGroup
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
declare const offlineStoreConfig: any;
declare const onlineStoreConfig: any;
const cfnFeatureGroup = new sagemaker.CfnFeatureGroup(this, 'MyCfnFeatureGroup', {
eventTimeFeatureName: 'eventTimeFeatureName',
featureDefinitions: [{
featureName: 'featureName',
featureType: 'featureType',
}],
featureGroupName: 'featureGroupName',
recordIdentifierFeatureName: 'recordIdentifierFeatureName',
// the properties below are optional
description: 'description',
offlineStoreConfig: offlineStoreConfig,
onlineStoreConfig: onlineStoreConfig,
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
throughputConfig: {
throughputMode: 'throughputMode',
// the properties below are optional
provisionedReadCapacityUnits: 123,
provisionedWriteCapacityUnits: 123,
},
});
Initializer
new CfnFeatureGroup(scope: Construct, id: string, props: CfnFeatureGroupProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Feature Group Props
Construct Props
Name | Type | Description |
---|---|---|
event | string | The name of the feature that stores the EventTime of a Record in a FeatureGroup . |
feature | IResolvable | IResolvable | Feature [] | A list of Feature s. Each Feature must include a FeatureName and a FeatureType . |
feature | string | The name of the FeatureGroup . |
record | string | The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions . |
description? | string | A free form description of a FeatureGroup . |
offline | any | The configuration of an OfflineStore . |
online | any | The configuration of an OnlineStore . |
role | string | The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. |
tags? | Cfn [] | Tags used to define a FeatureGroup . |
throughput | IResolvable | Throughput | Used to set feature group throughput configuration. |
eventTimeFeatureName
Type:
string
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
.
featureDefinitions
Type:
IResolvable
|
IResolvable
|
Feature
[]
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
.
featureGroupName
Type:
string
The name of the FeatureGroup
.
recordIdentifierFeatureName
Type:
string
The name of the Feature
whose value uniquely identifies a Record
defined in the FeatureGroup
FeatureDefinitions
.
description?
Type:
string
(optional)
A free form description of a FeatureGroup
.
offlineStoreConfig?
Type:
any
(optional)
The configuration of an OfflineStore
.
onlineStoreConfig?
Type:
any
(optional)
The configuration of an OnlineStore
.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
tags?
Type:
Cfn
[]
(optional)
Tags used to define a FeatureGroup
.
throughputConfig?
Type:
IResolvable
|
Throughput
(optional)
Used to set feature group throughput configuration.
There are two modes: ON_DEMAND
and PROVISIONED
. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: PROVISIONED
throughput mode is supported only for feature groups that are offline-only, or use the Standard
tier online store.
Properties
Name | Type | Description |
---|---|---|
attr | string | The time a FeatureGroup was created. |
attr | string | A FeatureGroup status. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
event | string | The name of the feature that stores the EventTime of a Record in a FeatureGroup . |
feature | IResolvable | IResolvable | Feature [] | A list of Feature s. |
feature | string | The name of the FeatureGroup . |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
record | string | The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions . |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
description? | string | A free form description of a FeatureGroup . |
offline | any | The configuration of an OfflineStore . |
online | any | The configuration of an OnlineStore . |
role | string | The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. |
tags | Cfn [] | Tags used to define a FeatureGroup . |
throughput | IResolvable | Throughput | Used to set feature group throughput configuration. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrCreationTime
Type:
string
The time a FeatureGroup
was created.
attrFeatureGroupStatus
Type:
string
A FeatureGroup
status.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
eventTimeFeatureName
Type:
string
The name of the feature that stores the EventTime
of a Record in a FeatureGroup
.
featureDefinitions
Type:
IResolvable
|
IResolvable
|
Feature
[]
A list of Feature
s.
Each Feature
must include a FeatureName
and a FeatureType
.
featureGroupName
Type:
string
The name of the FeatureGroup
.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
recordIdentifierFeatureName
Type:
string
The name of the Feature
whose value uniquely identifies a Record
defined in the FeatureGroup
FeatureDefinitions
.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
description?
Type:
string
(optional)
A free form description of a FeatureGroup
.
offlineStoreConfig?
Type:
any
(optional)
The configuration of an OfflineStore
.
onlineStoreConfig?
Type:
any
(optional)
The configuration of an OnlineStore
.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
tagsRaw?
Type:
Cfn
[]
(optional)
Tags used to define a FeatureGroup
.
throughputConfig?
Type:
IResolvable
|
Throughput
(optional)
Used to set feature group throughput configuration.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }