Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. CustomApplication
DataRobot v0.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.CustomApplication

Explore with Pulumi AI

datarobot logo
DataRobot v0.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

    Custom Application

    Example Usage

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

const exampleApplicationSource = new datarobot.ApplicationSource("exampleApplicationSource", {files: [
    ["start-app.sh"],
    ["streamlit-app.py"],
]});
const exampleCustomApplication = new datarobot.CustomApplication("exampleCustomApplication", {
    sourceVersionId: exampleApplicationSource.versionId,
    externalAccessEnabled: true,
    externalAccessRecipients: ["recipient@example.com"],
});
export const datarobotCustomApplicationId = exampleCustomApplication.id;
export const datarobotCustomApplicationSourceId = exampleCustomApplication.sourceId;
export const datarobotCustomApplicationSourceVersionId = exampleCustomApplication.sourceVersionId;
export const datarobotCustomApplicationUrl = exampleCustomApplication.applicationUrl;

    import pulumi
import pulumi_datarobot as datarobot

example_application_source = datarobot.ApplicationSource("exampleApplicationSource", files=[
    ["start-app.sh"],
    ["streamlit-app.py"],
])
example_custom_application = datarobot.CustomApplication("exampleCustomApplication",
    source_version_id=example_application_source.version_id,
    external_access_enabled=True,
    external_access_recipients=["recipient@example.com"])
pulumi.export("datarobotCustomApplicationId", example_custom_application.id)
pulumi.export("datarobotCustomApplicationSourceId", example_custom_application.source_id)
pulumi.export("datarobotCustomApplicationSourceVersionId", example_custom_application.source_version_id)
pulumi.export("datarobotCustomApplicationUrl", example_custom_application.application_url)

    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 {
		exampleApplicationSource, err := datarobot.NewApplicationSource(ctx, "exampleApplicationSource", &datarobot.ApplicationSourceArgs{
			Files: pulumi.Any{
				[]string{
					"start-app.sh",
				},
				[]string{
					"streamlit-app.py",
				},
			},
		})
		if err != nil {
			return err
		}
		exampleCustomApplication, err := datarobot.NewCustomApplication(ctx, "exampleCustomApplication", &datarobot.CustomApplicationArgs{
			SourceVersionId:       exampleApplicationSource.VersionId,
			ExternalAccessEnabled: pulumi.Bool(true),
			ExternalAccessRecipients: pulumi.StringArray{
				pulumi.String("recipient@example.com"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("datarobotCustomApplicationId", exampleCustomApplication.ID())
		ctx.Export("datarobotCustomApplicationSourceId", exampleCustomApplication.SourceId)
		ctx.Export("datarobotCustomApplicationSourceVersionId", exampleCustomApplication.SourceVersionId)
		ctx.Export("datarobotCustomApplicationUrl", exampleCustomApplication.ApplicationUrl)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleApplicationSource = new Datarobot.ApplicationSource("exampleApplicationSource", new()
    {
        Files = new[]
        {
            new[]
            {
                "start-app.sh",
            },
            new[]
            {
                "streamlit-app.py",
            },
        },
    });

    var exampleCustomApplication = new Datarobot.CustomApplication("exampleCustomApplication", new()
    {
        SourceVersionId = exampleApplicationSource.VersionId,
        ExternalAccessEnabled = true,
        ExternalAccessRecipients = new[]
        {
            "recipient@example.com",
        },
    });

    return new Dictionary<string, object?>
    {
        ["datarobotCustomApplicationId"] = exampleCustomApplication.Id,
        ["datarobotCustomApplicationSourceId"] = exampleCustomApplication.SourceId,
        ["datarobotCustomApplicationSourceVersionId"] = exampleCustomApplication.SourceVersionId,
        ["datarobotCustomApplicationUrl"] = exampleCustomApplication.ApplicationUrl,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datarobot.ApplicationSource;
import com.pulumi.datarobot.ApplicationSourceArgs;
import com.pulumi.datarobot.CustomApplication;
import com.pulumi.datarobot.CustomApplicationArgs;
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 exampleApplicationSource = new ApplicationSource("exampleApplicationSource", ApplicationSourceArgs.builder()
            .files(            
                "start-app.sh",
                "streamlit-app.py")
            .build());

        var exampleCustomApplication = new CustomApplication("exampleCustomApplication", CustomApplicationArgs.builder()
            .sourceVersionId(exampleApplicationSource.versionId())
            .externalAccessEnabled(true)
            .externalAccessRecipients("recipient@example.com")
            .build());

        ctx.export("datarobotCustomApplicationId", exampleCustomApplication.id());
        ctx.export("datarobotCustomApplicationSourceId", exampleCustomApplication.sourceId());
        ctx.export("datarobotCustomApplicationSourceVersionId", exampleCustomApplication.sourceVersionId());
        ctx.export("datarobotCustomApplicationUrl", exampleCustomApplication.applicationUrl());
    }
}

    resources:
  exampleApplicationSource:
    type: datarobot:ApplicationSource
    properties:
      files:
        - - start-app.sh
        - - streamlit-app.py
  exampleCustomApplication:
    type: datarobot:CustomApplication
    properties:
      sourceVersionId: ${exampleApplicationSource.versionId}
      # optional settings
      externalAccessEnabled: true
      externalAccessRecipients:
        - recipient@example.com
outputs:
  datarobotCustomApplicationId: ${exampleCustomApplication.id}
  datarobotCustomApplicationSourceId: ${exampleCustomApplication.sourceId}
  datarobotCustomApplicationSourceVersionId: ${exampleCustomApplication.sourceVersionId}
  datarobotCustomApplicationUrl: ${exampleCustomApplication.applicationUrl}

    Create CustomApplication Resource

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

    Constructor syntax

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

@overload
def CustomApplication(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      source_version_id: Optional[str] = None,
                      external_access_enabled: Optional[bool] = None,
                      external_access_recipients: Optional[Sequence[str]] = None,
                      name: Optional[str] = None,
                      use_case_ids: Optional[Sequence[str]] = None)
    func NewCustomApplication(ctx *Context, name string, args CustomApplicationArgs, opts ...ResourceOption) (*CustomApplication, error)
    public CustomApplication(string name, CustomApplicationArgs args, CustomResourceOptions? opts = null)
    public CustomApplication(String name, CustomApplicationArgs args)
public CustomApplication(String name, CustomApplicationArgs args, CustomResourceOptions options)

    type: datarobot:CustomApplication
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 CustomApplicationArgs
    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 CustomApplicationArgs
    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 CustomApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomApplicationArgs
    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 customApplicationResource = new Datarobot.CustomApplication("customApplicationResource", new()
{
    SourceVersionId = "string",
    ExternalAccessEnabled = false,
    ExternalAccessRecipients = new[]
    {
        "string",
    },
    Name = "string",
    UseCaseIds = new[]
    {
        "string",
    },
});

    example, err := datarobot.NewCustomApplication(ctx, "customApplicationResource", &datarobot.CustomApplicationArgs{
	SourceVersionId:       pulumi.String("string"),
	ExternalAccessEnabled: pulumi.Bool(false),
	ExternalAccessRecipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	UseCaseIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var customApplicationResource = new CustomApplication("customApplicationResource", CustomApplicationArgs.builder()
    .sourceVersionId("string")
    .externalAccessEnabled(false)
    .externalAccessRecipients("string")
    .name("string")
    .useCaseIds("string")
    .build());

    custom_application_resource = datarobot.CustomApplication("customApplicationResource",
    source_version_id="string",
    external_access_enabled=False,
    external_access_recipients=["string"],
    name="string",
    use_case_ids=["string"])

    const customApplicationResource = new datarobot.CustomApplication("customApplicationResource", {
    sourceVersionId: "string",
    externalAccessEnabled: false,
    externalAccessRecipients: ["string"],
    name: "string",
    useCaseIds: ["string"],
});

    type: datarobot:CustomApplication
properties:
    externalAccessEnabled: false
    externalAccessRecipients:
        - string
    name: string
    sourceVersionId: string
    useCaseIds:
        - string

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

    SourceVersionId string
    The version ID of the Custom Application Source.
    ExternalAccessEnabled bool
    Whether external access is enabled for the Custom Application.
    ExternalAccessRecipients List<string>
    The list of external email addresses that have access to the Custom Application.
    Name string
    The name of the Custom Application.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Custom Application to.
    SourceVersionId string
    The version ID of the Custom Application Source.
    ExternalAccessEnabled bool
    Whether external access is enabled for the Custom Application.
    ExternalAccessRecipients []string
    The list of external email addresses that have access to the Custom Application.
    Name string
    The name of the Custom Application.
    UseCaseIds []string
    The list of Use Case IDs to add the Custom Application to.
    sourceVersionId String
    The version ID of the Custom Application Source.
    externalAccessEnabled Boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients List<String>
    The list of external email addresses that have access to the Custom Application.
    name String
    The name of the Custom Application.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.
    sourceVersionId string
    The version ID of the Custom Application Source.
    externalAccessEnabled boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients string[]
    The list of external email addresses that have access to the Custom Application.
    name string
    The name of the Custom Application.
    useCaseIds string[]
    The list of Use Case IDs to add the Custom Application to.
    source_version_id str
    The version ID of the Custom Application Source.
    external_access_enabled bool
    Whether external access is enabled for the Custom Application.
    external_access_recipients Sequence[str]
    The list of external email addresses that have access to the Custom Application.
    name str
    The name of the Custom Application.
    use_case_ids Sequence[str]
    The list of Use Case IDs to add the Custom Application to.
    sourceVersionId String
    The version ID of the Custom Application Source.
    externalAccessEnabled Boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients List<String>
    The list of external email addresses that have access to the Custom Application.
    name String
    The name of the Custom Application.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.

    Outputs

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

    ApplicationUrl string
    The URL of the Custom Application.
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    The ID of the Custom Application Source.
    ApplicationUrl string
    The URL of the Custom Application.
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    The ID of the Custom Application Source.
    applicationUrl String
    The URL of the Custom Application.
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    The ID of the Custom Application Source.
    applicationUrl string
    The URL of the Custom Application.
    id string
    The provider-assigned unique ID for this managed resource.
    sourceId string
    The ID of the Custom Application Source.
    application_url str
    The URL of the Custom Application.
    id str
    The provider-assigned unique ID for this managed resource.
    source_id str
    The ID of the Custom Application Source.
    applicationUrl String
    The URL of the Custom Application.
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    The ID of the Custom Application Source.

    Look up Existing CustomApplication Resource

    Get an existing CustomApplication 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?: CustomApplicationState, opts?: CustomResourceOptions): CustomApplication
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_url: Optional[str] = None,
        external_access_enabled: Optional[bool] = None,
        external_access_recipients: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        source_id: Optional[str] = None,
        source_version_id: Optional[str] = None,
        use_case_ids: Optional[Sequence[str]] = None) -> CustomApplication
    func GetCustomApplication(ctx *Context, name string, id IDInput, state *CustomApplicationState, opts ...ResourceOption) (*CustomApplication, error)
    public static CustomApplication Get(string name, Input<string> id, CustomApplicationState? state, CustomResourceOptions? opts = null)
    public static CustomApplication get(String name, Output<String> id, CustomApplicationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApplicationUrl string
    The URL of the Custom Application.
    ExternalAccessEnabled bool
    Whether external access is enabled for the Custom Application.
    ExternalAccessRecipients List<string>
    The list of external email addresses that have access to the Custom Application.
    Name string
    The name of the Custom Application.
    SourceId string
    The ID of the Custom Application Source.
    SourceVersionId string
    The version ID of the Custom Application Source.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Custom Application to.
    ApplicationUrl string
    The URL of the Custom Application.
    ExternalAccessEnabled bool
    Whether external access is enabled for the Custom Application.
    ExternalAccessRecipients []string
    The list of external email addresses that have access to the Custom Application.
    Name string
    The name of the Custom Application.
    SourceId string
    The ID of the Custom Application Source.
    SourceVersionId string
    The version ID of the Custom Application Source.
    UseCaseIds []string
    The list of Use Case IDs to add the Custom Application to.
    applicationUrl String
    The URL of the Custom Application.
    externalAccessEnabled Boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients List<String>
    The list of external email addresses that have access to the Custom Application.
    name String
    The name of the Custom Application.
    sourceId String
    The ID of the Custom Application Source.
    sourceVersionId String
    The version ID of the Custom Application Source.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.
    applicationUrl string
    The URL of the Custom Application.
    externalAccessEnabled boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients string[]
    The list of external email addresses that have access to the Custom Application.
    name string
    The name of the Custom Application.
    sourceId string
    The ID of the Custom Application Source.
    sourceVersionId string
    The version ID of the Custom Application Source.
    useCaseIds string[]
    The list of Use Case IDs to add the Custom Application to.
    application_url str
    The URL of the Custom Application.
    external_access_enabled bool
    Whether external access is enabled for the Custom Application.
    external_access_recipients Sequence[str]
    The list of external email addresses that have access to the Custom Application.
    name str
    The name of the Custom Application.
    source_id str
    The ID of the Custom Application Source.
    source_version_id str
    The version ID of the Custom Application Source.
    use_case_ids Sequence[str]
    The list of Use Case IDs to add the Custom Application to.
    applicationUrl String
    The URL of the Custom Application.
    externalAccessEnabled Boolean
    Whether external access is enabled for the Custom Application.
    externalAccessRecipients List<String>
    The list of external email addresses that have access to the Custom Application.
    name String
    The name of the Custom Application.
    sourceId String
    The ID of the Custom Application Source.
    sourceVersionId String
    The version ID of the Custom Application Source.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.

    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.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.
    datarobot-community/pulumi-datarobot