1. Packages
  2. DataRobot
  3. API Docs
  4. CustomApplicationFromEnvironment
DataRobot v0.8.3 published on Wednesday, Feb 5, 2025 by DataRobot, Inc.

datarobot.CustomApplicationFromEnvironment

Explore with Pulumi AI

datarobot logo
DataRobot v0.8.3 published on Wednesday, Feb 5, 2025 by DataRobot, Inc.

    Custom Application created from an Execution Environment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as datarobot from "@datarobot/pulumi-datarobot";
    
    const example = new datarobot.CustomApplicationFromEnvironment("example", {
        environmentId: "6542cd582a9d3d51bf4ac71e",
        externalAccessEnabled: true,
        externalAccessRecipients: ["recipient@example.com"],
    });
    export const datarobotCustomApplicationId = example.id;
    export const datarobotCustomApplicationUrl = example.applicationUrl;
    
    import pulumi
    import pulumi_datarobot as datarobot
    
    example = datarobot.CustomApplicationFromEnvironment("example",
        environment_id="6542cd582a9d3d51bf4ac71e",
        external_access_enabled=True,
        external_access_recipients=["recipient@example.com"])
    pulumi.export("datarobotCustomApplicationId", example.id)
    pulumi.export("datarobotCustomApplicationUrl", example.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 {
    		example, err := datarobot.NewCustomApplicationFromEnvironment(ctx, "example", &datarobot.CustomApplicationFromEnvironmentArgs{
    			EnvironmentId:         pulumi.String("6542cd582a9d3d51bf4ac71e"),
    			ExternalAccessEnabled: pulumi.Bool(true),
    			ExternalAccessRecipients: pulumi.StringArray{
    				pulumi.String("recipient@example.com"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("datarobotCustomApplicationId", example.ID())
    		ctx.Export("datarobotCustomApplicationUrl", example.ApplicationUrl)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Datarobot = DataRobotPulumi.Datarobot;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Datarobot.CustomApplicationFromEnvironment("example", new()
        {
            EnvironmentId = "6542cd582a9d3d51bf4ac71e",
            ExternalAccessEnabled = true,
            ExternalAccessRecipients = new[]
            {
                "recipient@example.com",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["datarobotCustomApplicationId"] = example.Id,
            ["datarobotCustomApplicationUrl"] = example.ApplicationUrl,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.datarobot.CustomApplicationFromEnvironment;
    import com.pulumi.datarobot.CustomApplicationFromEnvironmentArgs;
    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 example = new CustomApplicationFromEnvironment("example", CustomApplicationFromEnvironmentArgs.builder()
                .environmentId("6542cd582a9d3d51bf4ac71e")
                .externalAccessEnabled(true)
                .externalAccessRecipients("recipient@example.com")
                .build());
    
            ctx.export("datarobotCustomApplicationId", example.id());
            ctx.export("datarobotCustomApplicationUrl", example.applicationUrl());
        }
    }
    
    resources:
      example:
        type: datarobot:CustomApplicationFromEnvironment
        properties:
          environmentId: 6542cd582a9d3d51bf4ac71e
          # optional settings
          externalAccessEnabled: true
          externalAccessRecipients:
            - recipient@example.com
    outputs:
      datarobotCustomApplicationId: ${example.id}
      datarobotCustomApplicationUrl: ${example.applicationUrl}
    

    Create CustomApplicationFromEnvironment Resource

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

    Constructor syntax

    new CustomApplicationFromEnvironment(name: string, args: CustomApplicationFromEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def CustomApplicationFromEnvironment(resource_name: str,
                                         args: CustomApplicationFromEnvironmentArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomApplicationFromEnvironment(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         environment_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 NewCustomApplicationFromEnvironment(ctx *Context, name string, args CustomApplicationFromEnvironmentArgs, opts ...ResourceOption) (*CustomApplicationFromEnvironment, error)
    public CustomApplicationFromEnvironment(string name, CustomApplicationFromEnvironmentArgs args, CustomResourceOptions? opts = null)
    public CustomApplicationFromEnvironment(String name, CustomApplicationFromEnvironmentArgs args)
    public CustomApplicationFromEnvironment(String name, CustomApplicationFromEnvironmentArgs args, CustomResourceOptions options)
    
    type: datarobot:CustomApplicationFromEnvironment
    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 CustomApplicationFromEnvironmentArgs
    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 CustomApplicationFromEnvironmentArgs
    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 CustomApplicationFromEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomApplicationFromEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomApplicationFromEnvironmentArgs
    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 customApplicationFromEnvironmentResource = new Datarobot.CustomApplicationFromEnvironment("customApplicationFromEnvironmentResource", new()
    {
        EnvironmentId = "string",
        ExternalAccessEnabled = false,
        ExternalAccessRecipients = new[]
        {
            "string",
        },
        Name = "string",
        UseCaseIds = new[]
        {
            "string",
        },
    });
    
    example, err := datarobot.NewCustomApplicationFromEnvironment(ctx, "customApplicationFromEnvironmentResource", &datarobot.CustomApplicationFromEnvironmentArgs{
    	EnvironmentId:         pulumi.String("string"),
    	ExternalAccessEnabled: pulumi.Bool(false),
    	ExternalAccessRecipients: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	UseCaseIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var customApplicationFromEnvironmentResource = new CustomApplicationFromEnvironment("customApplicationFromEnvironmentResource", CustomApplicationFromEnvironmentArgs.builder()
        .environmentId("string")
        .externalAccessEnabled(false)
        .externalAccessRecipients("string")
        .name("string")
        .useCaseIds("string")
        .build());
    
    custom_application_from_environment_resource = datarobot.CustomApplicationFromEnvironment("customApplicationFromEnvironmentResource",
        environment_id="string",
        external_access_enabled=False,
        external_access_recipients=["string"],
        name="string",
        use_case_ids=["string"])
    
    const customApplicationFromEnvironmentResource = new datarobot.CustomApplicationFromEnvironment("customApplicationFromEnvironmentResource", {
        environmentId: "string",
        externalAccessEnabled: false,
        externalAccessRecipients: ["string"],
        name: "string",
        useCaseIds: ["string"],
    });
    
    type: datarobot:CustomApplicationFromEnvironment
    properties:
        environmentId: string
        externalAccessEnabled: false
        externalAccessRecipients:
            - string
        name: string
        useCaseIds:
            - string
    

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

    EnvironmentId string
    The ID of the Execution Environment used to create 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.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Custom Application to.
    EnvironmentId string
    The ID of the Execution Environment used to create 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.
    UseCaseIds []string
    The list of Use Case IDs to add the Custom Application to.
    environmentId String
    The ID of the Execution Environment used to create 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.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.
    environmentId string
    The ID of the Execution Environment used to create 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.
    useCaseIds string[]
    The list of Use Case IDs to add the Custom Application to.
    environment_id str
    The ID of the Execution Environment used to create 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.
    use_case_ids Sequence[str]
    The list of Use Case IDs to add the Custom Application to.
    environmentId String
    The ID of the Execution Environment used to create 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.
    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 CustomApplicationFromEnvironment resource produces the following output properties:

    ApplicationUrl string
    The URL of the Custom Application.
    EnvironmentVersionId string
    The version ID of the Execution Environment used to create the Custom Application.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApplicationUrl string
    The URL of the Custom Application.
    EnvironmentVersionId string
    The version ID of the Execution Environment used to create the Custom Application.
    Id string
    The provider-assigned unique ID for this managed resource.
    applicationUrl String
    The URL of the Custom Application.
    environmentVersionId String
    The version ID of the Execution Environment used to create the Custom Application.
    id String
    The provider-assigned unique ID for this managed resource.
    applicationUrl string
    The URL of the Custom Application.
    environmentVersionId string
    The version ID of the Execution Environment used to create the Custom Application.
    id string
    The provider-assigned unique ID for this managed resource.
    application_url str
    The URL of the Custom Application.
    environment_version_id str
    The version ID of the Execution Environment used to create the Custom Application.
    id str
    The provider-assigned unique ID for this managed resource.
    applicationUrl String
    The URL of the Custom Application.
    environmentVersionId String
    The version ID of the Execution Environment used to create the Custom Application.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomApplicationFromEnvironment Resource

    Get an existing CustomApplicationFromEnvironment 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?: CustomApplicationFromEnvironmentState, opts?: CustomResourceOptions): CustomApplicationFromEnvironment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_url: Optional[str] = None,
            environment_id: Optional[str] = None,
            environment_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) -> CustomApplicationFromEnvironment
    func GetCustomApplicationFromEnvironment(ctx *Context, name string, id IDInput, state *CustomApplicationFromEnvironmentState, opts ...ResourceOption) (*CustomApplicationFromEnvironment, error)
    public static CustomApplicationFromEnvironment Get(string name, Input<string> id, CustomApplicationFromEnvironmentState? state, CustomResourceOptions? opts = null)
    public static CustomApplicationFromEnvironment get(String name, Output<String> id, CustomApplicationFromEnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: datarobot:CustomApplicationFromEnvironment    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:
    ApplicationUrl string
    The URL of the Custom Application.
    EnvironmentId string
    The ID of the Execution Environment used to create the Custom Application.
    EnvironmentVersionId string
    The version ID of the Execution Environment used to create 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.
    UseCaseIds List<string>
    The list of Use Case IDs to add the Custom Application to.
    ApplicationUrl string
    The URL of the Custom Application.
    EnvironmentId string
    The ID of the Execution Environment used to create the Custom Application.
    EnvironmentVersionId string
    The version ID of the Execution Environment used to create 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.
    UseCaseIds []string
    The list of Use Case IDs to add the Custom Application to.
    applicationUrl String
    The URL of the Custom Application.
    environmentId String
    The ID of the Execution Environment used to create the Custom Application.
    environmentVersionId String
    The version ID of the Execution Environment used to create 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.
    useCaseIds List<String>
    The list of Use Case IDs to add the Custom Application to.
    applicationUrl string
    The URL of the Custom Application.
    environmentId string
    The ID of the Execution Environment used to create the Custom Application.
    environmentVersionId string
    The version ID of the Execution Environment used to create 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.
    useCaseIds string[]
    The list of Use Case IDs to add the Custom Application to.
    application_url str
    The URL of the Custom Application.
    environment_id str
    The ID of the Execution Environment used to create the Custom Application.
    environment_version_id str
    The version ID of the Execution Environment used to create 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.
    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.
    environmentId String
    The ID of the Execution Environment used to create the Custom Application.
    environmentVersionId String
    The version ID of the Execution Environment used to create 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.
    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.8.3 published on Wednesday, Feb 5, 2025 by DataRobot, Inc.