CfnFeatureGroup

class aws_cdk.aws_sagemaker.CfnFeatureGroup(scope, id, *, event_time_feature_name, feature_definitions, feature_group_name, record_identifier_feature_name, description=None, offline_store_config=None, online_store_config=None, role_arn=None, tags=None, throughput_config=None)

Bases: CfnResource

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. .. epigraph:

You must include at least one of ``OnlineStoreConfig`` and ``OfflineStoreConfig`` to create a ``FeatureGroup`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html
CloudformationResource:: AWS::SageMaker::FeatureGroup
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

# offline_store_config: Any
# online_store_config: Any

cfn_feature_group = sagemaker.CfnFeatureGroup(self, "MyCfnFeatureGroup",
    event_time_feature_name="eventTimeFeatureName",
    feature_definitions=[sagemaker.CfnFeatureGroup.FeatureDefinitionProperty(
        feature_name="featureName",
        feature_type="featureType"
    )],
    feature_group_name="featureGroupName",
    record_identifier_feature_name="recordIdentifierFeatureName",

    # the properties below are optional
    description="description",
    offline_store_config=offline_store_config,
    online_store_config=online_store_config,
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    throughput_config=sagemaker.CfnFeatureGroup.ThroughputConfigProperty(
        throughput_mode="throughputMode",

        # the properties below are optional
        provisioned_read_capacity_units=123,
        provisioned_write_capacity_units=123
    )
)

Create a new AWS::SageMaker::FeatureGroup.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
event_time_feature_name (str) – 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 .
feature_definitions (Union[IResolvable, Sequence[Union[IResolvable, FeatureDefinitionProperty, Dict[str, Any]]]]) – 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 .
feature_group_name (str) – The name of the FeatureGroup .
record_identifier_feature_name (str) – The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions .
description (Optional[str]) – A free form description of a FeatureGroup .
offline_store_config (Any) – The configuration of an OfflineStore .
online_store_config (Any) – The configuration of an OnlineStore .
role_arn (Union[str, IRoleRef, None]) – The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags used to define a FeatureGroup .
throughput_config (Union[IResolvable, ThroughputConfigProperty, Dict[str, Any], None]) – 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 <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType>`_ tier online store.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

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.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

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.

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

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)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

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.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SageMaker::FeatureGroup'

attr_creation_time

The time a FeatureGroup was created.

CloudformationAttribute:: CreationTime

attr_feature_group_status

A FeatureGroup status.

CloudformationAttribute:: FeatureGroupStatus

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A free form description of a FeatureGroup .

env

event_time_feature_name: The name of the feature that stores the EventTime of a Record in a FeatureGroup .

feature_definitions

A list of Feature s.

Each Feature must include a FeatureName and a FeatureType .

feature_group_name: The name of the FeatureGroup .

feature_group_ref: A reference to a FeatureGroup resource.

logical_id

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).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

offline_store_config: The configuration of an OfflineStore .

online_store_config: The configuration of an OnlineStore .

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

ref

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 }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: Tags used to define a FeatureGroup .

throughput_config: Used to set feature group throughput configuration.

Static Methods

classmethod arn_for_feature_group(resource)

Parameters:: resource (IFeatureGroupRef)
Return type:: str

classmethod from_feature_group_name(scope, id, feature_group_name)

Creates a new IFeatureGroupRef from a featureGroupName.

Parameters:

scope (Construct)
id (str)
feature_group_name (str)

Return type:

IFeatureGroupRef

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DataCatalogConfigProperty

class CfnFeatureGroup.DataCatalogConfigProperty(*, catalog, database, table_name)

Bases: object

The meta data of the Glue table which serves as data catalog for the OfflineStore .

Parameters:

catalog (str) – The name of the Glue table catalog.
database (str) – The name of the Glue table database.
table_name (str) – The name of the Glue table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

data_catalog_config_property = sagemaker.CfnFeatureGroup.DataCatalogConfigProperty(
    catalog="catalog",
    database="database",
    table_name="tableName"
)

Attributes

catalog

The name of the Glue table catalog.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-catalog

database

The name of the Glue table database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-database

table_name

The name of the Glue table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-tablename

FeatureDefinitionProperty

class CfnFeatureGroup.FeatureDefinitionProperty(*, feature_name, feature_type)

Bases: object

A list of features.

You must include FeatureName and FeatureType . Valid feature FeatureType s are Integral , Fractional and String .

Parameters:

feature_name (str) – The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time . The name: - Must start with an alphanumeric character. - Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
feature_type (str) – The value type of a feature. Valid values are Integral, Fractional, or String.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

feature_definition_property = sagemaker.CfnFeatureGroup.FeatureDefinitionProperty(
    feature_name="featureName",
    feature_type="featureType"
)

Attributes

feature_name

The name of a feature.

The type must be a string. FeatureName cannot be any of the following: is_deleted , write_time , api_invocation_time .

The name:

Must start with an alphanumeric character.
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featurename

feature_type

The value type of a feature.

Valid values are Integral, Fractional, or String.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featuretype

OfflineStoreConfigProperty

class CfnFeatureGroup.OfflineStoreConfigProperty(*, s3_storage_config, data_catalog_config=None, disable_glue_table_creation=None, table_format=None)

Bases: object

The configuration of an OfflineStore .

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore .

To encrypt an OfflineStore using at rest data encryption, specify AWS Key Management Service (KMS) key ID, or KMSKeyId , in S3StorageConfig .

Parameters:

s3_storage_config (Union[IResolvable, S3StorageConfigProperty, Dict[str, Any]]) – The Amazon Simple Storage (Amazon S3) location of OfflineStore .
data_catalog_config (Union[IResolvable, DataCatalogConfigProperty, Dict[str, Any], None]) – The meta data of the Glue table that is autogenerated when an OfflineStore is created.
disable_glue_table_creation (Union[bool, IResolvable, None]) – Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore . If set to False , Feature Store will name the OfflineStore Glue table following Athena’s naming recommendations . The default value is False .
table_format (Optional[str]) – Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

offline_store_config_property = sagemaker.CfnFeatureGroup.OfflineStoreConfigProperty(
    s3_storage_config=sagemaker.CfnFeatureGroup.S3StorageConfigProperty(
        s3_uri="s3Uri",

        # the properties below are optional
        kms_key_id="kmsKeyId"
    ),

    # the properties below are optional
    data_catalog_config=sagemaker.CfnFeatureGroup.DataCatalogConfigProperty(
        catalog="catalog",
        database="database",
        table_name="tableName"
    ),
    disable_glue_table_creation=False,
    table_format="tableFormat"
)

Attributes

data_catalog_config

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-datacatalogconfig

disable_glue_table_creation

Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore .

If set to False , Feature Store will name the OfflineStore Glue table following Athena’s naming recommendations .

The default value is False .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-disablegluetablecreation

s3_storage_config

The Amazon Simple Storage (Amazon S3) location of OfflineStore .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-s3storageconfig

table_format

Format for the offline store table.

Supported formats are Glue (Default) and Apache Iceberg .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-tableformat

OnlineStoreConfigProperty

class CfnFeatureGroup.OnlineStoreConfigProperty(*, enable_online_store=None, security_config=None, storage_type=None, ttl_duration=None)

Bases: object

Use this to specify the AWS Key Management Service (KMS) Key ID, or KMSKeyId , for at rest data encryption.

You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False .

Parameters:

enable_online_store (Union[bool, IResolvable, None]) – Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag. The default value is False .
security_config (Union[IResolvable, OnlineStoreSecurityConfigProperty, Dict[str, Any], None]) – Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .
storage_type (Optional[str]) – Option for different tiers of low latency storage for real-time data retrieval. - Standard : A managed low latency data store for feature groups. - InMemory : A managed data store for feature groups that supports very low latency retrieval.
ttl_duration (Union[IResolvable, TtlDurationProperty, Dict[str, Any], None]) – Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

online_store_config_property = sagemaker.CfnFeatureGroup.OnlineStoreConfigProperty(
    enable_online_store=False,
    security_config=sagemaker.CfnFeatureGroup.OnlineStoreSecurityConfigProperty(
        kms_key_id="kmsKeyId"
    ),
    storage_type="storageType",
    ttl_duration=sagemaker.CfnFeatureGroup.TtlDurationProperty(
        unit="unit",
        value=123
    )
)

Attributes

enable_online_store

Turn OnlineStore off by specifying False for the EnableOnlineStore flag.

Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-enableonlinestore

security_config

Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your OnlineStore .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-securityconfig

storage_type

Option for different tiers of low latency storage for real-time data retrieval.

Standard : A managed low latency data store for feature groups.
InMemory : A managed data store for feature groups that supports very low latency retrieval.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-storagetype

ttl_duration

Time to live duration, where the record is hard deleted after the expiration time is reached;

ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-ttlduration

OnlineStoreSecurityConfigProperty

class CfnFeatureGroup.OnlineStoreSecurityConfigProperty(*, kms_key_id=None)

Bases: object

The security configuration for OnlineStore .

Parameters:: kms_key_id (Optional[str]) – The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption. The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId : - "kms:Encrypt" - "kms:Decrypt" - "kms:DescribeKey" - "kms:CreateGrant" - "kms:RetireGrant" - "kms:ReEncryptFrom" - "kms:ReEncryptTo" - "kms:GenerateDataKey" - "kms:ListAliases" - "kms:ListGrants" - "kms:RevokeGrant" The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId : - "kms:Decrypt"
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

online_store_security_config_property = sagemaker.CfnFeatureGroup.OnlineStoreSecurityConfigProperty(
    kms_key_id="kmsKeyId"
)

Attributes

kms_key_id

The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId :

"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"

The caller (either user or IAM role) to all DataPlane operations ( PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

"kms:Decrypt"

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html#cfn-sagemaker-featuregroup-onlinestoresecurityconfig-kmskeyid

S3StorageConfigProperty

class CfnFeatureGroup.S3StorageConfigProperty(*, s3_uri, kms_key_id=None)

Bases: object

The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore .

Parameters:

s3_uri (str) – The S3 URI, or location in Amazon S3, of OfflineStore . S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .
kms_key_id (Optional[str]) – The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location. The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId : - "kms:GenerateDataKey"

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

s3_storage_config_property = sagemaker.CfnFeatureGroup.S3StorageConfigProperty(
    s3_uri="s3Uri",

    # the properties below are optional
    kms_key_id="kmsKeyId"
)

Attributes

kms_key_id

The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

"kms:GenerateDataKey"

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-kmskeyid

s3_uri

The S3 URI, or location in Amazon S3, of OfflineStore .

S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-s3uri

ThroughputConfigProperty

class CfnFeatureGroup.ThroughputConfigProperty(*, throughput_mode, provisioned_read_capacity_units=None, provisioned_write_capacity_units=None)

Bases: object

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 <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType>`_ tier online store.

Parameters:

throughput_mode (str) – The mode used for your feature group throughput: ON_DEMAND or PROVISIONED .
provisioned_read_capacity_units (Union[int, float, None]) – For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. This field is not applicable for on-demand feature groups.
provisioned_write_capacity_units (Union[int, float, None]) – For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. This field is not applicable for on-demand feature groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

throughput_config_property = sagemaker.CfnFeatureGroup.ThroughputConfigProperty(
    throughput_mode="throughputMode",

    # the properties below are optional
    provisioned_read_capacity_units=123,
    provisioned_write_capacity_units=123
)

Attributes

provisioned_read_capacity_units

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedreadcapacityunits

provisioned_write_capacity_units

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedwritecapacityunits

throughput_mode

ON_DEMAND or PROVISIONED .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-throughputmode
Type:: The mode used for your feature group throughput

TtlDurationProperty

class CfnFeatureGroup.TtlDurationProperty(*, unit=None, value=None)

Bases: object

Time to live duration, where the record is hard deleted after the expiration time is reached;

ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

Parameters:

unit (Optional[str]) – TtlDuration time unit.
value (Union[int, float, None]) – TtlDuration time value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

ttl_duration_property = sagemaker.CfnFeatureGroup.TtlDurationProperty(
    unit="unit",
    value=123
)

Attributes

unit

TtlDuration time unit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-unit

value

TtlDuration time value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-value