modelServing.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package databricks

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// This resource allows you to manage [Model Serving](https://docs.databricks.com/machine-learning/model-serving/index.html) endpoints in Databricks.
//
// **Note** If you replace `servedModels` with `servedEntities` in an existing serving endpoint, the serving endpoint will briefly go into an update state (~30 seconds) and increment the config version.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := databricks.NewModelServing(ctx, "this", &databricks.ModelServingArgs{
//				Name: pulumi.String("ads-serving-endpoint"),
//				Config: &databricks.ModelServingConfigArgs{
//					ServedEntities: databricks.ModelServingConfigServedEntityArray{
//						&databricks.ModelServingConfigServedEntityArgs{
//							Name:               pulumi.String("prod_model"),
//							EntityName:         pulumi.String("ads-model"),
//							EntityVersion:      pulumi.String("2"),
//							WorkloadSize:       pulumi.String("Small"),
//							ScaleToZeroEnabled: pulumi.Bool(true),
//						},
//						&databricks.ModelServingConfigServedEntityArgs{
//							Name:               pulumi.String("candidate_model"),
//							EntityName:         pulumi.String("ads-model"),
//							EntityVersion:      pulumi.String("4"),
//							WorkloadSize:       pulumi.String("Small"),
//							ScaleToZeroEnabled: pulumi.Bool(false),
//						},
//					},
//					TrafficConfig: &databricks.ModelServingConfigTrafficConfigArgs{
//						Routes: databricks.ModelServingConfigTrafficConfigRouteArray{
//							&databricks.ModelServingConfigTrafficConfigRouteArgs{
//								ServedModelName:   pulumi.String("prod_model"),
//								TrafficPercentage: pulumi.Int(90),
//							},
//							&databricks.ModelServingConfigTrafficConfigRouteArgs{
//								ServedModelName:   pulumi.String("candidate_model"),
//								TrafficPercentage: pulumi.Int(10),
//							},
//						},
//					},
//				},
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
//
// ## Access Control
//
// * Permissions can control which groups or individual users can *Manage*, *Query* or *View* individual serving endpoints.
//
// ## Related Resources
//
// The following resources are often used in the same context:
//
// * RegisteredModel to create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.
// * End to end workspace management guide.
// * Directory to manage directories in [Databricks Workspace](https://docs.databricks.com/workspace/workspace-objects.html).
// * MlflowModel to create models in the [workspace model registry](https://docs.databricks.com/en/mlflow/model-registry.html) in Databricks.
// * Notebook to manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).
// * Notebook data to export a notebook from Databricks Workspace.
// * Repo to manage [Databricks Repos](https://docs.databricks.com/repos.html).
//
// ## Import
//
// The model serving resource can be imported using the name of the endpoint.
//
// bash
//
// ```sh
// $ pulumi import databricks:index/modelServing:ModelServing this <model-serving-endpoint-name>
// ```
type ModelServing struct {
	pulumi.CustomResourceState

	// The model serving endpoint configuration.
	Config ModelServingConfigOutput `pulumi:"config"`
	// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
	RateLimits ModelServingRateLimitArrayOutput `pulumi:"rateLimits"`
	// Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.
	ServingEndpointId pulumi.StringOutput `pulumi:"servingEndpointId"`
	// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
	Tags ModelServingTagArrayOutput `pulumi:"tags"`
}

// NewModelServing registers a new resource with the given unique name, arguments, and options.
func NewModelServing(ctx *pulumi.Context,
	name string, args *ModelServingArgs, opts ...pulumi.ResourceOption) (*ModelServing, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Config == nil {
		return nil, errors.New("invalid value for required argument 'Config'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource ModelServing
	err := ctx.RegisterResource("databricks:index/modelServing:ModelServing", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetModelServing gets an existing ModelServing resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetModelServing(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ModelServingState, opts ...pulumi.ResourceOption) (*ModelServing, error) {
	var resource ModelServing
	err := ctx.ReadResource("databricks:index/modelServing:ModelServing", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering ModelServing resources.
type modelServingState struct {
	// The model serving endpoint configuration.
	Config *ModelServingConfig `pulumi:"config"`
	// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
	Name *string `pulumi:"name"`
	// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
	RateLimits []ModelServingRateLimit `pulumi:"rateLimits"`
	// Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.
	ServingEndpointId *string `pulumi:"servingEndpointId"`
	// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
	Tags []ModelServingTag `pulumi:"tags"`
}

type ModelServingState struct {
	// The model serving endpoint configuration.
	Config ModelServingConfigPtrInput
	// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
	Name pulumi.StringPtrInput
	// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
	RateLimits ModelServingRateLimitArrayInput
	// Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.
	ServingEndpointId pulumi.StringPtrInput
	// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
	Tags ModelServingTagArrayInput
}

func (ModelServingState) ElementType() reflect.Type {
	return reflect.TypeOf((*modelServingState)(nil)).Elem()
}

type modelServingArgs struct {
	// The model serving endpoint configuration.
	Config ModelServingConfig `pulumi:"config"`
	// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
	Name *string `pulumi:"name"`
	// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
	RateLimits []ModelServingRateLimit `pulumi:"rateLimits"`
	// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
	Tags []ModelServingTag `pulumi:"tags"`
}

// The set of arguments for constructing a ModelServing resource.
type ModelServingArgs struct {
	// The model serving endpoint configuration.
	Config ModelServingConfigInput
	// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
	Name pulumi.StringPtrInput
	// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
	RateLimits ModelServingRateLimitArrayInput
	// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
	Tags ModelServingTagArrayInput
}

func (ModelServingArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*modelServingArgs)(nil)).Elem()
}

type ModelServingInput interface {
	pulumi.Input

	ToModelServingOutput() ModelServingOutput
	ToModelServingOutputWithContext(ctx context.Context) ModelServingOutput
}

func (*ModelServing) ElementType() reflect.Type {
	return reflect.TypeOf((**ModelServing)(nil)).Elem()
}

func (i *ModelServing) ToModelServingOutput() ModelServingOutput {
	return i.ToModelServingOutputWithContext(context.Background())
}

func (i *ModelServing) ToModelServingOutputWithContext(ctx context.Context) ModelServingOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ModelServingOutput)
}

// ModelServingArrayInput is an input type that accepts ModelServingArray and ModelServingArrayOutput values.
// You can construct a concrete instance of `ModelServingArrayInput` via:
//
//	ModelServingArray{ ModelServingArgs{...} }
type ModelServingArrayInput interface {
	pulumi.Input

	ToModelServingArrayOutput() ModelServingArrayOutput
	ToModelServingArrayOutputWithContext(context.Context) ModelServingArrayOutput
}

type ModelServingArray []ModelServingInput

func (ModelServingArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ModelServing)(nil)).Elem()
}

func (i ModelServingArray) ToModelServingArrayOutput() ModelServingArrayOutput {
	return i.ToModelServingArrayOutputWithContext(context.Background())
}

func (i ModelServingArray) ToModelServingArrayOutputWithContext(ctx context.Context) ModelServingArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ModelServingArrayOutput)
}

// ModelServingMapInput is an input type that accepts ModelServingMap and ModelServingMapOutput values.
// You can construct a concrete instance of `ModelServingMapInput` via:
//
//	ModelServingMap{ "key": ModelServingArgs{...} }
type ModelServingMapInput interface {
	pulumi.Input

	ToModelServingMapOutput() ModelServingMapOutput
	ToModelServingMapOutputWithContext(context.Context) ModelServingMapOutput
}

type ModelServingMap map[string]ModelServingInput

func (ModelServingMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ModelServing)(nil)).Elem()
}

func (i ModelServingMap) ToModelServingMapOutput() ModelServingMapOutput {
	return i.ToModelServingMapOutputWithContext(context.Background())
}

func (i ModelServingMap) ToModelServingMapOutputWithContext(ctx context.Context) ModelServingMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ModelServingMapOutput)
}

type ModelServingOutput struct{ *pulumi.OutputState }

func (ModelServingOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**ModelServing)(nil)).Elem()
}

func (o ModelServingOutput) ToModelServingOutput() ModelServingOutput {
	return o
}

func (o ModelServingOutput) ToModelServingOutputWithContext(ctx context.Context) ModelServingOutput {
	return o
}

// The model serving endpoint configuration.
func (o ModelServingOutput) Config() ModelServingConfigOutput {
	return o.ApplyT(func(v *ModelServing) ModelServingConfigOutput { return v.Config }).(ModelServingConfigOutput)
}

// The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
func (o ModelServingOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *ModelServing) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// A list of rate limits to be applied to the serving endpoint. NOTE: only external and foundation model endpoints are supported as of now.
func (o ModelServingOutput) RateLimits() ModelServingRateLimitArrayOutput {
	return o.ApplyT(func(v *ModelServing) ModelServingRateLimitArrayOutput { return v.RateLimits }).(ModelServingRateLimitArrayOutput)
}

// Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.
func (o ModelServingOutput) ServingEndpointId() pulumi.StringOutput {
	return o.ApplyT(func(v *ModelServing) pulumi.StringOutput { return v.ServingEndpointId }).(pulumi.StringOutput)
}

// Tags to be attached to the serving endpoint and automatically propagated to billing logs.
func (o ModelServingOutput) Tags() ModelServingTagArrayOutput {
	return o.ApplyT(func(v *ModelServing) ModelServingTagArrayOutput { return v.Tags }).(ModelServingTagArrayOutput)
}

type ModelServingArrayOutput struct{ *pulumi.OutputState }

func (ModelServingArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ModelServing)(nil)).Elem()
}

func (o ModelServingArrayOutput) ToModelServingArrayOutput() ModelServingArrayOutput {
	return o
}

func (o ModelServingArrayOutput) ToModelServingArrayOutputWithContext(ctx context.Context) ModelServingArrayOutput {
	return o
}

func (o ModelServingArrayOutput) Index(i pulumi.IntInput) ModelServingOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ModelServing {
		return vs[0].([]*ModelServing)[vs[1].(int)]
	}).(ModelServingOutput)
}

type ModelServingMapOutput struct{ *pulumi.OutputState }

func (ModelServingMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ModelServing)(nil)).Elem()
}

func (o ModelServingMapOutput) ToModelServingMapOutput() ModelServingMapOutput {
	return o
}

func (o ModelServingMapOutput) ToModelServingMapOutputWithContext(ctx context.Context) ModelServingMapOutput {
	return o
}

func (o ModelServingMapOutput) MapIndex(k pulumi.StringInput) ModelServingOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *ModelServing {
		return vs[0].(map[string]*ModelServing)[vs[1].(string)]
	}).(ModelServingOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*ModelServingInput)(nil)).Elem(), &ModelServing{})
	pulumi.RegisterInputType(reflect.TypeOf((*ModelServingArrayInput)(nil)).Elem(), ModelServingArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*ModelServingMapInput)(nil)).Elem(), ModelServingMap{})
	pulumi.RegisterOutputType(ModelServingOutput{})
	pulumi.RegisterOutputType(ModelServingArrayOutput{})
	pulumi.RegisterOutputType(ModelServingMapOutput{})
}