Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. RegisteredModel
DataRobot v0.8.16 published on Tuesday, Mar 18, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.RegisteredModel

Explore with Pulumi AI

datarobot logo
DataRobot v0.8.16 published on Tuesday, Mar 18, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

    registered model

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datarobot from "@datarobot/pulumi-datarobot";

const exampleCustomModel = new datarobot.CustomModel("exampleCustomModel", {
    description: "Description for the example custom model",
    targetType: "Binary",
    targetName: "my_label",
    baseEnvironmentId: "65f9b27eab986d30d4c64268",
    files: ["example.py"],
});
const exampleRegisteredModel = new datarobot.RegisteredModel("exampleRegisteredModel", {
    customModelVersionId: exampleCustomModel.versionId,
    description: "Description for the example registered model",
});
export const datarobotRegisteredModelId = exampleRegisteredModel.id;
export const datarobotRegisteredModelVersionId = exampleRegisteredModel.versionId;

    import pulumi
import pulumi_datarobot as datarobot

example_custom_model = datarobot.CustomModel("exampleCustomModel",
    description="Description for the example custom model",
    target_type="Binary",
    target_name="my_label",
    base_environment_id="65f9b27eab986d30d4c64268",
    files=["example.py"])
example_registered_model = datarobot.RegisteredModel("exampleRegisteredModel",
    custom_model_version_id=example_custom_model.version_id,
    description="Description for the example registered model")
pulumi.export("datarobotRegisteredModelId", example_registered_model.id)
pulumi.export("datarobotRegisteredModelVersionId", example_registered_model.version_id)

    package main

import (
	"github.com/datarobot-community/pulumi-datarobot/sdk/go/datarobot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleCustomModel, err := datarobot.NewCustomModel(ctx, "exampleCustomModel", &datarobot.CustomModelArgs{
			Description:       pulumi.String("Description for the example custom model"),
			TargetType:        pulumi.String("Binary"),
			TargetName:        pulumi.String("my_label"),
			BaseEnvironmentId: pulumi.String("65f9b27eab986d30d4c64268"),
			Files: pulumi.Any{
				"example.py",
			},
		})
		if err != nil {
			return err
		}
		exampleRegisteredModel, err := datarobot.NewRegisteredModel(ctx, "exampleRegisteredModel", &datarobot.RegisteredModelArgs{
			CustomModelVersionId: exampleCustomModel.VersionId,
			Description:          pulumi.String("Description for the example registered model"),
		})
		if err != nil {
			return err
		}
		ctx.Export("datarobotRegisteredModelId", exampleRegisteredModel.ID())
		ctx.Export("datarobotRegisteredModelVersionId", exampleRegisteredModel.VersionId)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datarobot = DataRobotPulumi.Datarobot;

return await Deployment.RunAsync(() => 
{
    var exampleCustomModel = new Datarobot.CustomModel("exampleCustomModel", new()
    {
        Description = "Description for the example custom model",
        TargetType = "Binary",
        TargetName = "my_label",
        BaseEnvironmentId = "65f9b27eab986d30d4c64268",
        Files = new[]
        {
            "example.py",
        },
    });

    var exampleRegisteredModel = new Datarobot.RegisteredModel("exampleRegisteredModel", new()
    {
        CustomModelVersionId = exampleCustomModel.VersionId,
        Description = "Description for the example registered model",
    });

    return new Dictionary<string, object?>
    {
        ["datarobotRegisteredModelId"] = exampleRegisteredModel.Id,
        ["datarobotRegisteredModelVersionId"] = exampleRegisteredModel.VersionId,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datarobot.CustomModel;
import com.pulumi.datarobot.CustomModelArgs;
import com.pulumi.datarobot.RegisteredModel;
import com.pulumi.datarobot.RegisteredModelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleCustomModel = new CustomModel("exampleCustomModel", CustomModelArgs.builder()
            .description("Description for the example custom model")
            .targetType("Binary")
            .targetName("my_label")
            .baseEnvironmentId("65f9b27eab986d30d4c64268")
            .files("example.py")
            .build());

        var exampleRegisteredModel = new RegisteredModel("exampleRegisteredModel", RegisteredModelArgs.builder()
            .customModelVersionId(exampleCustomModel.versionId())
            .description("Description for the example registered model")
            .build());

        ctx.export("datarobotRegisteredModelId", exampleRegisteredModel.id());
        ctx.export("datarobotRegisteredModelVersionId", exampleRegisteredModel.versionId());
    }
}

    resources:
  exampleCustomModel:
    type: datarobot:CustomModel
    properties:
      description: Description for the example custom model
      targetType: Binary
      targetName: my_label
      baseEnvironmentId: 65f9b27eab986d30d4c64268
      files:
        - example.py
  exampleRegisteredModel:
    type: datarobot:RegisteredModel
    properties:
      customModelVersionId: ${exampleCustomModel.versionId}
      description: Description for the example registered model
outputs:
  datarobotRegisteredModelId: ${exampleRegisteredModel.id}
  datarobotRegisteredModelVersionId: ${exampleRegisteredModel.versionId}

    Create RegisteredModel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RegisteredModel(name: string, args: RegisteredModelArgs, opts?: CustomResourceOptions);
    @overload
def RegisteredModel(resource_name: str,
                    args: RegisteredModelArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def RegisteredModel(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    custom_model_version_id: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    use_case_ids: Optional[Sequence[str]] = None,
                    version_name: Optional[str] = None)
    func NewRegisteredModel(ctx *Context, name string, args RegisteredModelArgs, opts ...ResourceOption) (*RegisteredModel, error)
    public RegisteredModel(string name, RegisteredModelArgs args, CustomResourceOptions? opts = null)
    public RegisteredModel(String name, RegisteredModelArgs args)
public RegisteredModel(String name, RegisteredModelArgs args, CustomResourceOptions options)

    type: datarobot:RegisteredModel
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 RegisteredModelArgs
    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 RegisteredModelArgs
    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 RegisteredModelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegisteredModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegisteredModelArgs
    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 registeredModelResource = new Datarobot.RegisteredModel("registeredModelResource", new()
{
    CustomModelVersionId = "string",
    Description = "string",
    Name = "string",
    UseCaseIds = new[]
    {
        "string",
    },
    VersionName = "string",
});

    example, err := datarobot.NewRegisteredModel(ctx, "registeredModelResource", &datarobot.RegisteredModelArgs{
	CustomModelVersionId: pulumi.String("string"),
	Description:          pulumi.String("string"),
	Name:                 pulumi.String("string"),
	UseCaseIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	VersionName: pulumi.String("string"),
})

    var registeredModelResource = new RegisteredModel("registeredModelResource", RegisteredModelArgs.builder()
    .customModelVersionId("string")
    .description("string")
    .name("string")
    .useCaseIds("string")
    .versionName("string")
    .build());

    registered_model_resource = datarobot.RegisteredModel("registeredModelResource",
    custom_model_version_id="string",
    description="string",
    name="string",
    use_case_ids=["string"],
    version_name="string")

    const registeredModelResource = new datarobot.RegisteredModel("registeredModelResource", {
    customModelVersionId: "string",
    description: "string",
    name: "string",
    useCaseIds: ["string"],
    versionName: "string",
});

    type: datarobot:RegisteredModel
properties:
    customModelVersionId: string
    description: string
    name: string
    useCaseIds:
        - string
    versionName: string

    RegisteredModel 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 RegisteredModel resource accepts the following input properties:

    CustomModelVersionId string
    The ID of the custom model version for this Registered Model.
    Description string
    The description of the Registered Model.
    Name string
    The name of the Registered Model.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Registered Model version to.
    VersionName string
    The name of the Registered Model Version.
    CustomModelVersionId string
    The ID of the custom model version for this Registered Model.
    Description string
    The description of the Registered Model.
    Name string
    The name of the Registered Model.
    UseCaseIds []string
    The list of Use Case IDs to add the Registered Model version to.
    VersionName string
    The name of the Registered Model Version.
    customModelVersionId String
    The ID of the custom model version for this Registered Model.
    description String
    The description of the Registered Model.
    name String
    The name of the Registered Model.
    useCaseIds List<String>
    The list of Use Case IDs to add the Registered Model version to.
    versionName String
    The name of the Registered Model Version.
    customModelVersionId string
    The ID of the custom model version for this Registered Model.
    description string
    The description of the Registered Model.
    name string
    The name of the Registered Model.
    useCaseIds string[]
    The list of Use Case IDs to add the Registered Model version to.
    versionName string
    The name of the Registered Model Version.
    custom_model_version_id str
    The ID of the custom model version for this Registered Model.
    description str
    The description of the Registered Model.
    name str
    The name of the Registered Model.
    use_case_ids Sequence[str]
    The list of Use Case IDs to add the Registered Model version to.
    version_name str
    The name of the Registered Model Version.
    customModelVersionId String
    The ID of the custom model version for this Registered Model.
    description String
    The description of the Registered Model.
    name String
    The name of the Registered Model.
    useCaseIds List<String>
    The list of Use Case IDs to add the Registered Model version to.
    versionName String
    The name of the Registered Model Version.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegisteredModel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VersionId string
    The ID of the Registered Model Version.
    Id string
    The provider-assigned unique ID for this managed resource.
    VersionId string
    The ID of the Registered Model Version.
    id String
    The provider-assigned unique ID for this managed resource.
    versionId String
    The ID of the Registered Model Version.
    id string
    The provider-assigned unique ID for this managed resource.
    versionId string
    The ID of the Registered Model Version.
    id str
    The provider-assigned unique ID for this managed resource.
    version_id str
    The ID of the Registered Model Version.
    id String
    The provider-assigned unique ID for this managed resource.
    versionId String
    The ID of the Registered Model Version.

    Look up Existing RegisteredModel Resource

    Get an existing RegisteredModel 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?: RegisteredModelState, opts?: CustomResourceOptions): RegisteredModel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_model_version_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        use_case_ids: Optional[Sequence[str]] = None,
        version_id: Optional[str] = None,
        version_name: Optional[str] = None) -> RegisteredModel
    func GetRegisteredModel(ctx *Context, name string, id IDInput, state *RegisteredModelState, opts ...ResourceOption) (*RegisteredModel, error)
    public static RegisteredModel Get(string name, Input<string> id, RegisteredModelState? state, CustomResourceOptions? opts = null)
    public static RegisteredModel get(String name, Output<String> id, RegisteredModelState state, CustomResourceOptions options)
    resources:  _:    type: datarobot:RegisteredModel    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.
    The following state arguments are supported:
    CustomModelVersionId string
    The ID of the custom model version for this Registered Model.
    Description string
    The description of the Registered Model.
    Name string
    The name of the Registered Model.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Registered Model version to.
    VersionId string
    The ID of the Registered Model Version.
    VersionName string
    The name of the Registered Model Version.
    CustomModelVersionId string
    The ID of the custom model version for this Registered Model.
    Description string
    The description of the Registered Model.
    Name string
    The name of the Registered Model.
    UseCaseIds []string
    The list of Use Case IDs to add the Registered Model version to.
    VersionId string
    The ID of the Registered Model Version.
    VersionName string
    The name of the Registered Model Version.
    customModelVersionId String
    The ID of the custom model version for this Registered Model.
    description String
    The description of the Registered Model.
    name String
    The name of the Registered Model.
    useCaseIds List<String>
    The list of Use Case IDs to add the Registered Model version to.
    versionId String
    The ID of the Registered Model Version.
    versionName String
    The name of the Registered Model Version.
    customModelVersionId string
    The ID of the custom model version for this Registered Model.
    description string
    The description of the Registered Model.
    name string
    The name of the Registered Model.
    useCaseIds string[]
    The list of Use Case IDs to add the Registered Model version to.
    versionId string
    The ID of the Registered Model Version.
    versionName string
    The name of the Registered Model Version.
    custom_model_version_id str
    The ID of the custom model version for this Registered Model.
    description str
    The description of the Registered Model.
    name str
    The name of the Registered Model.
    use_case_ids Sequence[str]
    The list of Use Case IDs to add the Registered Model version to.
    version_id str
    The ID of the Registered Model Version.
    version_name str
    The name of the Registered Model Version.
    customModelVersionId String
    The ID of the custom model version for this Registered Model.
    description String
    The description of the Registered Model.
    name String
    The name of the Registered Model.
    useCaseIds List<String>
    The list of Use Case IDs to add the Registered Model version to.
    versionId String
    The ID of the Registered Model Version.
    versionName String
    The name of the Registered Model Version.

    Package Details

    Repository
    datarobot datarobot-community/pulumi-datarobot
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datarobot Terraform Provider.
    datarobot logo
    DataRobot v0.8.16 published on Tuesday, Mar 18, 2025 by DataRobot, Inc.
    datarobot-community/pulumi-datarobot