sagemaker_feature_group.md

permalink
/sagemaker_feature_group/

sagemaker_feature_group

sagemaker_feature_group represents the aws_sagemaker_feature_group Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withDescription()
• fn withEventTimeFeatureName()
• fn withFeatureDefinition()
• fn withFeatureDefinitionMixin()
• fn withFeatureGroupName()
• fn withOfflineStoreConfig()
• fn withOfflineStoreConfigMixin()
• fn withOnlineStoreConfig()
• fn withOnlineStoreConfigMixin()
• fn withRecordIdentifierFeatureName()
• fn withRoleArn()
• fn withTags()
• fn withTagsAll()
• obj feature_definition
  • fn new()
• obj offline_store_config
  • fn new()
  • obj offline_store_config.data_catalog_config
    • fn new()
  • obj offline_store_config.s3_storage_config
    • fn new()
• obj online_store_config
  • fn new()
  • obj online_store_config.security_config
    • fn new()
  • obj online_store_config.ttl_duration
    • fn new()

Fields

fn new

new()

aws.sagemaker_feature_group.new injects a new aws_sagemaker_feature_group Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.sagemaker_feature_group.new('some_id')

You can get the reference to the id field of the created aws.sagemaker_feature_group using the reference:

$._ref.aws_sagemaker_feature_group.some_id.get('id')

This is the same as directly entering "${ aws_sagemaker_feature_group.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• event_time_feature_name (string): Set the event_time_feature_name field on the resulting resource block.
• feature_group_name (string): Set the feature_group_name field on the resulting resource block.
• record_identifier_feature_name (string): Set the record_identifier_feature_name field on the resulting resource block.
• role_arn (string): Set the role_arn field on the resulting resource block.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• feature_definition (list[obj]): Set the feature_definition field on the resulting resource block. When null, the feature_definition sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.feature_definition.new constructor.
• offline_store_config (list[obj]): Set the offline_store_config field on the resulting resource block. When null, the offline_store_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.offline_store_config.new constructor.
• online_store_config (list[obj]): Set the online_store_config field on the resulting resource block. When null, the online_store_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.online_store_config.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.sagemaker_feature_group.newAttrs constructs a new object with attributes and blocks configured for the sagemaker_feature_group Terraform resource.

Unlike aws.sagemaker_feature_group.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
• event_time_feature_name (string): Set the event_time_feature_name field on the resulting object.
• feature_group_name (string): Set the feature_group_name field on the resulting object.
• record_identifier_feature_name (string): Set the record_identifier_feature_name field on the resulting object.
• role_arn (string): Set the role_arn field on the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• feature_definition (list[obj]): Set the feature_definition field on the resulting object. When null, the feature_definition sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.feature_definition.new constructor.
• offline_store_config (list[obj]): Set the offline_store_config field on the resulting object. When null, the offline_store_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.offline_store_config.new constructor.
• online_store_config (list[obj]): Set the online_store_config field on the resulting object. When null, the online_store_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.online_store_config.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new sagemaker_feature_group resource into the root Terraform configuration.

fn withDescription

withDescription()

aws.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the description field.

fn withEventTimeFeatureName

withEventTimeFeatureName()

aws.string.withEventTimeFeatureName constructs a mixin object that can be merged into the string Terraform resource block to set or update the event_time_feature_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the event_time_feature_name field.

fn withFeatureDefinition

withFeatureDefinition()

aws.list[obj].withFeatureDefinition constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the feature_definition field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withFeatureDefinitionMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the feature_definition field.

fn withFeatureDefinitionMixin

withFeatureDefinitionMixin()

aws.list[obj].withFeatureDefinitionMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the feature_definition field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withFeatureDefinition function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the feature_definition field.

fn withFeatureGroupName

withFeatureGroupName()

aws.string.withFeatureGroupName constructs a mixin object that can be merged into the string Terraform resource block to set or update the feature_group_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the feature_group_name field.

fn withOfflineStoreConfig

withOfflineStoreConfig()

aws.list[obj].withOfflineStoreConfig constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the offline_store_config field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withOfflineStoreConfigMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the offline_store_config field.

fn withOfflineStoreConfigMixin

withOfflineStoreConfigMixin()

aws.list[obj].withOfflineStoreConfigMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the offline_store_config field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withOfflineStoreConfig function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the offline_store_config field.

fn withOnlineStoreConfig

withOnlineStoreConfig()

aws.list[obj].withOnlineStoreConfig constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the online_store_config field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withOnlineStoreConfigMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the online_store_config field.

fn withOnlineStoreConfigMixin

withOnlineStoreConfigMixin()

aws.list[obj].withOnlineStoreConfigMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the online_store_config field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withOnlineStoreConfig function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the online_store_config field.

fn withRecordIdentifierFeatureName

withRecordIdentifierFeatureName()

aws.string.withRecordIdentifierFeatureName constructs a mixin object that can be merged into the string Terraform resource block to set or update the record_identifier_feature_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the record_identifier_feature_name field.

fn withRoleArn

withRoleArn()

aws.string.withRoleArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the role_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the role_arn field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

obj feature_definition

fn feature_definition.new

new()

aws.sagemaker_feature_group.feature_definition.new constructs a new object with attributes and blocks configured for the feature_definition Terraform sub block.

Args:

• feature_name (string): Set the feature_name field on the resulting object. When null, the feature_name field will be omitted from the resulting object.
• feature_type (string): Set the feature_type field on the resulting object. When null, the feature_type field will be omitted from the resulting object.

Returns:

• An attribute object that represents the feature_definition sub block.

obj offline_store_config

fn offline_store_config.new

new()

aws.sagemaker_feature_group.offline_store_config.new constructs a new object with attributes and blocks configured for the offline_store_config Terraform sub block.

Args:

• disable_glue_table_creation (bool): Set the disable_glue_table_creation field on the resulting object. When null, the disable_glue_table_creation field will be omitted from the resulting object.
• table_format (string): Set the table_format field on the resulting object. When null, the table_format field will be omitted from the resulting object.
• data_catalog_config (list[obj]): Set the data_catalog_config field on the resulting object. When null, the data_catalog_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.offline_store_config.data_catalog_config.new constructor.
• s3_storage_config (list[obj]): Set the s3_storage_config field on the resulting object. When null, the s3_storage_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.offline_store_config.s3_storage_config.new constructor.

Returns:

• An attribute object that represents the offline_store_config sub block.

obj offline_store_config.data_catalog_config

fn offline_store_config.data_catalog_config.new

new()

aws.sagemaker_feature_group.offline_store_config.data_catalog_config.new constructs a new object with attributes and blocks configured for the data_catalog_config Terraform sub block.

Args:

• catalog (string): Set the catalog field on the resulting object. When null, the catalog field will be omitted from the resulting object.
• database (string): Set the database field on the resulting object. When null, the database field will be omitted from the resulting object.
• table_name (string): Set the table_name field on the resulting object. When null, the table_name field will be omitted from the resulting object.

Returns:

• An attribute object that represents the data_catalog_config sub block.

obj offline_store_config.s3_storage_config

fn offline_store_config.s3_storage_config.new

new()

aws.sagemaker_feature_group.offline_store_config.s3_storage_config.new constructs a new object with attributes and blocks configured for the s3_storage_config Terraform sub block.

Args:

• kms_key_id (string): Set the kms_key_id field on the resulting object. When null, the kms_key_id field will be omitted from the resulting object.
• resolved_output_s3_uri (string): Set the resolved_output_s3_uri field on the resulting object. When null, the resolved_output_s3_uri field will be omitted from the resulting object.
• s3_uri (string): Set the s3_uri field on the resulting object.

Returns:

• An attribute object that represents the s3_storage_config sub block.

obj online_store_config

fn online_store_config.new

new()

aws.sagemaker_feature_group.online_store_config.new constructs a new object with attributes and blocks configured for the online_store_config Terraform sub block.

Args:

• enable_online_store (bool): Set the enable_online_store field on the resulting object. When null, the enable_online_store field will be omitted from the resulting object.
• storage_type (string): Set the storage_type field on the resulting object. When null, the storage_type field will be omitted from the resulting object.
• security_config (list[obj]): Set the security_config field on the resulting object. When null, the security_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.online_store_config.security_config.new constructor.
• ttl_duration (list[obj]): Set the ttl_duration field on the resulting object. When null, the ttl_duration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.sagemaker_feature_group.online_store_config.ttl_duration.new constructor.

Returns:

• An attribute object that represents the online_store_config sub block.

obj online_store_config.security_config

fn online_store_config.security_config.new

new()

aws.sagemaker_feature_group.online_store_config.security_config.new constructs a new object with attributes and blocks configured for the security_config Terraform sub block.

Args:

• kms_key_id (string): Set the kms_key_id field on the resulting object. When null, the kms_key_id field will be omitted from the resulting object.

Returns:

• An attribute object that represents the security_config sub block.

obj online_store_config.ttl_duration

fn online_store_config.ttl_duration.new

new()

aws.sagemaker_feature_group.online_store_config.ttl_duration.new constructs a new object with attributes and blocks configured for the ttl_duration Terraform sub block.

Args:

• unit (string): Set the unit field on the resulting object. When null, the unit field will be omitted from the resulting object.
• value (number): Set the value field on the resulting object. When null, the value field will be omitted from the resulting object.

Returns:

• An attribute object that represents the ttl_duration sub block.