databricks.FeatureEngineeringMaterializedFeature
Create FeatureEngineeringMaterializedFeature Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FeatureEngineeringMaterializedFeature(name: string, args: FeatureEngineeringMaterializedFeatureArgs, opts?: CustomResourceOptions);@overload
def FeatureEngineeringMaterializedFeature(resource_name: str,
args: FeatureEngineeringMaterializedFeatureArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FeatureEngineeringMaterializedFeature(resource_name: str,
opts: Optional[ResourceOptions] = None,
feature_name: Optional[str] = None,
offline_store_config: Optional[FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs] = None,
online_store_config: Optional[FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs] = None,
pipeline_schedule_state: Optional[str] = None)func NewFeatureEngineeringMaterializedFeature(ctx *Context, name string, args FeatureEngineeringMaterializedFeatureArgs, opts ...ResourceOption) (*FeatureEngineeringMaterializedFeature, error)public FeatureEngineeringMaterializedFeature(string name, FeatureEngineeringMaterializedFeatureArgs args, CustomResourceOptions? opts = null)
public FeatureEngineeringMaterializedFeature(String name, FeatureEngineeringMaterializedFeatureArgs args)
public FeatureEngineeringMaterializedFeature(String name, FeatureEngineeringMaterializedFeatureArgs args, CustomResourceOptions options)
type: databricks:FeatureEngineeringMaterializedFeature
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FeatureEngineeringMaterializedFeatureArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FeatureEngineeringMaterializedFeatureArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FeatureEngineeringMaterializedFeatureArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FeatureEngineeringMaterializedFeatureArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FeatureEngineeringMaterializedFeatureArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var featureEngineeringMaterializedFeatureResource = new Databricks.FeatureEngineeringMaterializedFeature("featureEngineeringMaterializedFeatureResource", new()
{
FeatureName = "string",
OfflineStoreConfig = new Databricks.Inputs.FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs
{
CatalogName = "string",
SchemaName = "string",
TableNamePrefix = "string",
},
OnlineStoreConfig = new Databricks.Inputs.FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs
{
Capacity = "string",
Name = "string",
CreationTime = "string",
Creator = "string",
ReadReplicaCount = 0,
State = "string",
},
PipelineScheduleState = "string",
});
example, err := databricks.NewFeatureEngineeringMaterializedFeature(ctx, "featureEngineeringMaterializedFeatureResource", &databricks.FeatureEngineeringMaterializedFeatureArgs{
FeatureName: pulumi.String("string"),
OfflineStoreConfig: &databricks.FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs{
CatalogName: pulumi.String("string"),
SchemaName: pulumi.String("string"),
TableNamePrefix: pulumi.String("string"),
},
OnlineStoreConfig: &databricks.FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs{
Capacity: pulumi.String("string"),
Name: pulumi.String("string"),
CreationTime: pulumi.String("string"),
Creator: pulumi.String("string"),
ReadReplicaCount: pulumi.Int(0),
State: pulumi.String("string"),
},
PipelineScheduleState: pulumi.String("string"),
})
var featureEngineeringMaterializedFeatureResource = new FeatureEngineeringMaterializedFeature("featureEngineeringMaterializedFeatureResource", FeatureEngineeringMaterializedFeatureArgs.builder()
.featureName("string")
.offlineStoreConfig(FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs.builder()
.catalogName("string")
.schemaName("string")
.tableNamePrefix("string")
.build())
.onlineStoreConfig(FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs.builder()
.capacity("string")
.name("string")
.creationTime("string")
.creator("string")
.readReplicaCount(0)
.state("string")
.build())
.pipelineScheduleState("string")
.build());
feature_engineering_materialized_feature_resource = databricks.FeatureEngineeringMaterializedFeature("featureEngineeringMaterializedFeatureResource",
feature_name="string",
offline_store_config={
"catalog_name": "string",
"schema_name": "string",
"table_name_prefix": "string",
},
online_store_config={
"capacity": "string",
"name": "string",
"creation_time": "string",
"creator": "string",
"read_replica_count": 0,
"state": "string",
},
pipeline_schedule_state="string")
const featureEngineeringMaterializedFeatureResource = new databricks.FeatureEngineeringMaterializedFeature("featureEngineeringMaterializedFeatureResource", {
featureName: "string",
offlineStoreConfig: {
catalogName: "string",
schemaName: "string",
tableNamePrefix: "string",
},
onlineStoreConfig: {
capacity: "string",
name: "string",
creationTime: "string",
creator: "string",
readReplicaCount: 0,
state: "string",
},
pipelineScheduleState: "string",
});
type: databricks:FeatureEngineeringMaterializedFeature
properties:
featureName: string
offlineStoreConfig:
catalogName: string
schemaName: string
tableNamePrefix: string
onlineStoreConfig:
capacity: string
creationTime: string
creator: string
name: string
readReplicaCount: 0
state: string
pipelineScheduleState: string
FeatureEngineeringMaterializedFeature Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FeatureEngineeringMaterializedFeature resource accepts the following input properties:
- Feature
Name string - The full name of the feature in Unity Catalog
- Offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - Online
Store FeatureConfig Engineering Materialized Feature Online Store Config - Pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
- Feature
Name string - The full name of the feature in Unity Catalog
- Offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config Args - Online
Store FeatureConfig Engineering Materialized Feature Online Store Config Args - Pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
- feature
Name String - The full name of the feature in Unity Catalog
- offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - online
Store FeatureConfig Engineering Materialized Feature Online Store Config - pipeline
Schedule StringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
- feature
Name string - The full name of the feature in Unity Catalog
- offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - online
Store FeatureConfig Engineering Materialized Feature Online Store Config - pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
- feature_
name str - The full name of the feature in Unity Catalog
- offline_
store_ Featureconfig Engineering Materialized Feature Offline Store Config Args - online_
store_ Featureconfig Engineering Materialized Feature Online Store Config Args - pipeline_
schedule_ strstate - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
- feature
Name String - The full name of the feature in Unity Catalog
- offline
Store Property MapConfig - online
Store Property MapConfig - pipeline
Schedule StringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT
Outputs
All input properties are implicitly available as output properties. Additionally, the FeatureEngineeringMaterializedFeature resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- Materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- Table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- Materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- Table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- id String
- The provider-assigned unique ID for this managed resource.
- last
Materialization StringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature StringId - (string) - Unique identifier for the materialized feature
- table
Name String - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- id string
- The provider-assigned unique ID for this managed resource.
- last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- id str
- The provider-assigned unique ID for this managed resource.
- last_
materialization_ strtime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized_
feature_ strid - (string) - Unique identifier for the materialized feature
- table_
name str - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- id String
- The provider-assigned unique ID for this managed resource.
- last
Materialization StringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature StringId - (string) - Unique identifier for the materialized feature
- table
Name String - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
Look up Existing FeatureEngineeringMaterializedFeature Resource
Get an existing FeatureEngineeringMaterializedFeature resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FeatureEngineeringMaterializedFeatureState, opts?: CustomResourceOptions): FeatureEngineeringMaterializedFeature@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
feature_name: Optional[str] = None,
last_materialization_time: Optional[str] = None,
materialized_feature_id: Optional[str] = None,
offline_store_config: Optional[FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs] = None,
online_store_config: Optional[FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs] = None,
pipeline_schedule_state: Optional[str] = None,
table_name: Optional[str] = None) -> FeatureEngineeringMaterializedFeaturefunc GetFeatureEngineeringMaterializedFeature(ctx *Context, name string, id IDInput, state *FeatureEngineeringMaterializedFeatureState, opts ...ResourceOption) (*FeatureEngineeringMaterializedFeature, error)public static FeatureEngineeringMaterializedFeature Get(string name, Input<string> id, FeatureEngineeringMaterializedFeatureState? state, CustomResourceOptions? opts = null)public static FeatureEngineeringMaterializedFeature get(String name, Output<String> id, FeatureEngineeringMaterializedFeatureState state, CustomResourceOptions options)resources: _: type: databricks:FeatureEngineeringMaterializedFeature get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Feature
Name string - The full name of the feature in Unity Catalog
- Last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- Materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- Offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - Online
Store FeatureConfig Engineering Materialized Feature Online Store Config - Pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - Table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- Feature
Name string - The full name of the feature in Unity Catalog
- Last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- Materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- Offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config Args - Online
Store FeatureConfig Engineering Materialized Feature Online Store Config Args - Pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - Table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- feature
Name String - The full name of the feature in Unity Catalog
- last
Materialization StringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature StringId - (string) - Unique identifier for the materialized feature
- offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - online
Store FeatureConfig Engineering Materialized Feature Online Store Config - pipeline
Schedule StringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - table
Name String - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- feature
Name string - The full name of the feature in Unity Catalog
- last
Materialization stringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature stringId - (string) - Unique identifier for the materialized feature
- offline
Store FeatureConfig Engineering Materialized Feature Offline Store Config - online
Store FeatureConfig Engineering Materialized Feature Online Store Config - pipeline
Schedule stringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - table
Name string - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- feature_
name str - The full name of the feature in Unity Catalog
- last_
materialization_ strtime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized_
feature_ strid - (string) - Unique identifier for the materialized feature
- offline_
store_ Featureconfig Engineering Materialized Feature Offline Store Config Args - online_
store_ Featureconfig Engineering Materialized Feature Online Store Config Args - pipeline_
schedule_ strstate - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - table_
name str - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
- feature
Name String - The full name of the feature in Unity Catalog
- last
Materialization StringTime - (string) - The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null
- materialized
Feature StringId - (string) - Unique identifier for the materialized feature
- offline
Store Property MapConfig - online
Store Property MapConfig - pipeline
Schedule StringState - The schedule state of the materialization pipeline. Possible values are:
ACTIVE,PAUSED,SNAPSHOT - table
Name String - (string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only
Supporting Types
FeatureEngineeringMaterializedFeatureOfflineStoreConfig, FeatureEngineeringMaterializedFeatureOfflineStoreConfigArgs
- Catalog
Name string - The Unity Catalog catalog name
- Schema
Name string - The Unity Catalog schema name
- Table
Name stringPrefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
- Catalog
Name string - The Unity Catalog catalog name
- Schema
Name string - The Unity Catalog schema name
- Table
Name stringPrefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
- catalog
Name String - The Unity Catalog catalog name
- schema
Name String - The Unity Catalog schema name
- table
Name StringPrefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
- catalog
Name string - The Unity Catalog catalog name
- schema
Name string - The Unity Catalog schema name
- table
Name stringPrefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
- catalog_
name str - The Unity Catalog catalog name
- schema_
name str - The Unity Catalog schema name
- table_
name_ strprefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
- catalog
Name String - The Unity Catalog catalog name
- schema
Name String - The Unity Catalog schema name
- table
Name StringPrefix - Prefix for Unity Catalog table name. The materialized feature will be stored in a table with this prefix and a generated postfix
FeatureEngineeringMaterializedFeatureOnlineStoreConfig, FeatureEngineeringMaterializedFeatureOnlineStoreConfigArgs
- Capacity string
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- Name string
- The name of the online store. This is the unique identifier for the online store
- Creation
Time string - (string) - The timestamp when the online store was created
- Creator string
- (string) - The email of the creator of the online store
- Read
Replica intCount - The number of read replicas for the online store. Defaults to 0
- State string
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
- Capacity string
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- Name string
- The name of the online store. This is the unique identifier for the online store
- Creation
Time string - (string) - The timestamp when the online store was created
- Creator string
- (string) - The email of the creator of the online store
- Read
Replica intCount - The number of read replicas for the online store. Defaults to 0
- State string
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
- capacity String
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- name String
- The name of the online store. This is the unique identifier for the online store
- creation
Time String - (string) - The timestamp when the online store was created
- creator String
- (string) - The email of the creator of the online store
- read
Replica IntegerCount - The number of read replicas for the online store. Defaults to 0
- state String
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
- capacity string
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- name string
- The name of the online store. This is the unique identifier for the online store
- creation
Time string - (string) - The timestamp when the online store was created
- creator string
- (string) - The email of the creator of the online store
- read
Replica numberCount - The number of read replicas for the online store. Defaults to 0
- state string
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
- capacity str
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- name str
- The name of the online store. This is the unique identifier for the online store
- creation_
time str - (string) - The timestamp when the online store was created
- creator str
- (string) - The email of the creator of the online store
- read_
replica_ intcount - The number of read replicas for the online store. Defaults to 0
- state str
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
- capacity String
- The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
- name String
- The name of the online store. This is the unique identifier for the online store
- creation
Time String - (string) - The timestamp when the online store was created
- creator String
- (string) - The email of the creator of the online store
- read
Replica NumberCount - The number of read replicas for the online store. Defaults to 0
- state String
- (string) - The current state of the online store. Possible values are:
AVAILABLE,DELETING,FAILING_OVER,STARTING,STOPPED,UPDATING
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = “materialized_feature_id”
to = databricks_feature_engineering_materialized_feature.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:
$ pulumi import databricks:index/featureEngineeringMaterializedFeature:FeatureEngineeringMaterializedFeature this "materialized_feature_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
