AWS Classic v5.33.0, Mar 24 23

aws.sagemaker.App

Provides a SageMaker App resource.

Example Usage

Basic usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sagemaker.App("example", new()
    {
        DomainId = aws_sagemaker_domain.Example.Id,
        UserProfileName = aws_sagemaker_user_profile.Example.User_profile_name,
        AppName = "example",
        AppType = "JupyterServer",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewApp(ctx, "example", &sagemaker.AppArgs{
			DomainId:        pulumi.Any(aws_sagemaker_domain.Example.Id),
			UserProfileName: pulumi.Any(aws_sagemaker_user_profile.Example.User_profile_name),
			AppName:         pulumi.String("example"),
			AppType:         pulumi.String("JupyterServer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.App;
import com.pulumi.aws.sagemaker.AppArgs;
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 App("example", AppArgs.builder()        
            .domainId(aws_sagemaker_domain.example().id())
            .userProfileName(aws_sagemaker_user_profile.example().user_profile_name())
            .appName("example")
            .appType("JupyterServer")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.sagemaker.App("example",
    domain_id=aws_sagemaker_domain["example"]["id"],
    user_profile_name=aws_sagemaker_user_profile["example"]["user_profile_name"],
    app_name="example",
    app_type="JupyterServer")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sagemaker.App("example", {
    domainId: aws_sagemaker_domain.example.id,
    userProfileName: aws_sagemaker_user_profile.example.user_profile_name,
    appName: "example",
    appType: "JupyterServer",
});

resources:
  example:
    type: aws:sagemaker:App
    properties:
      domainId: ${aws_sagemaker_domain.example.id}
      userProfileName: ${aws_sagemaker_user_profile.example.user_profile_name}
      appName: example
      appType: JupyterServer

Create App Resource

new App(name: string, args: AppArgs, opts?: CustomResourceOptions);

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        app_name: Optional[str] = None,
        app_type: Optional[str] = None,
        domain_id: Optional[str] = None,
        resource_spec: Optional[AppResourceSpecArgs] = None,
        space_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        user_profile_name: Optional[str] = None)
@overload
def App(resource_name: str,
        args: AppArgs,
        opts: Optional[ResourceOptions] = None)

func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)

public App(string name, AppArgs args, CustomResourceOptions? opts = null)

public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

type: aws:sagemaker:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppArgs: 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 AppArgs: 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 AppArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AppArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

App Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The App resource accepts the following input properties:

AppName string: The name of the app.
AppType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
DomainId string: The domain ID.
ResourceSpec Pulumi.Aws.Sagemaker.Inputs.AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
SpaceName string: The name of the space. At least one of user_profile_name or space_name required.
Tags Dictionary<string, string>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
UserProfileName string: The user profile name. At least one of user_profile_name or space_name required.

AppName string: The name of the app.
AppType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
DomainId string: The domain ID.
ResourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
SpaceName string: The name of the space. At least one of user_profile_name or space_name required.
Tags map[string]string: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
UserProfileName string: The user profile name. At least one of user_profile_name or space_name required.

appName String: The name of the app.
appType String: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
domainId String: The domain ID.
resourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName String: The name of the space. At least one of user_profile_name or space_name required.
tags Map<String,String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
userProfileName String: The user profile name. At least one of user_profile_name or space_name required.

appName string: The name of the app.
appType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
domainId string: The domain ID.
resourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName string: The name of the space. At least one of user_profile_name or space_name required.
tags {[key: string]: string}: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
userProfileName string: The user profile name. At least one of user_profile_name or space_name required.

app_name str: The name of the app.
app_type str: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
domain_id str: The domain ID.
resource_spec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
space_name str: The name of the space. At least one of user_profile_name or space_name required.
tags Mapping[str, str]: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
user_profile_name str: The user profile name. At least one of user_profile_name or space_name required.

appName String: The name of the app.
appType String: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
domainId String: The domain ID.
resourceSpec Property Map: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName String: The name of the space. At least one of user_profile_name or space_name required.
tags Map<String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
userProfileName String: The user profile name. At least one of user_profile_name or space_name required.

Outputs

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

Arn string: The Amazon Resource Name (ARN) of the app.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The Amazon Resource Name (ARN) of the app.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the app.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The Amazon Resource Name (ARN) of the app.
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The Amazon Resource Name (ARN) of the app.
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the app.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing App Resource

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_name: Optional[str] = None,
        app_type: Optional[str] = None,
        arn: Optional[str] = None,
        domain_id: Optional[str] = None,
        resource_spec: Optional[AppResourceSpecArgs] = None,
        space_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        user_profile_name: Optional[str] = None) -> App

func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)

public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)

public static App get(String name, Output<String> id, AppState 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:

AppName string: The name of the app.
AppType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
Arn string: The Amazon Resource Name (ARN) of the app.
DomainId string: The domain ID.
ResourceSpec Pulumi.Aws.Sagemaker.Inputs.AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
SpaceName string: The name of the space. At least one of user_profile_name or space_name required.
Tags Dictionary<string, string>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
UserProfileName string: The user profile name. At least one of user_profile_name or space_name required.

AppName string: The name of the app.
AppType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
Arn string: The Amazon Resource Name (ARN) of the app.
DomainId string: The domain ID.
ResourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
SpaceName string: The name of the space. At least one of user_profile_name or space_name required.
Tags map[string]string: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
UserProfileName string: The user profile name. At least one of user_profile_name or space_name required.

appName String: The name of the app.
appType String: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
arn String: The Amazon Resource Name (ARN) of the app.
domainId String: The domain ID.
resourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName String: The name of the space. At least one of user_profile_name or space_name required.
tags Map<String,String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
userProfileName String: The user profile name. At least one of user_profile_name or space_name required.

appName string: The name of the app.
appType string: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
arn string: The Amazon Resource Name (ARN) of the app.
domainId string: The domain ID.
resourceSpec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName string: The name of the space. At least one of user_profile_name or space_name required.
tags {[key: string]: string}: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
userProfileName string: The user profile name. At least one of user_profile_name or space_name required.

app_name str: The name of the app.
app_type str: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
arn str: The Amazon Resource Name (ARN) of the app.
domain_id str: The domain ID.
resource_spec AppResourceSpecArgs: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
space_name str: The name of the space. At least one of user_profile_name or space_name required.
tags Mapping[str, str]: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
user_profile_name str: The user profile name. At least one of user_profile_name or space_name required.

appName String: The name of the app.
appType String: The type of app. Valid values are JupyterServer, KernelGateway, RStudioServerPro, RSessionGateway and TensorBoard.
arn String: The Amazon Resource Name (ARN) of the app.
domainId String: The domain ID.
resourceSpec Property Map: The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
spaceName String: The name of the space. At least one of user_profile_name or space_name required.
tags Map<String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
userProfileName String: The user profile name. At least one of user_profile_name or space_name required.

Supporting Types

AppResourceSpec

InstanceType string: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
LifecycleConfigArn string: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
SagemakerImageArn string: The ARN of the SageMaker image that the image version belongs to.
SagemakerImageVersionArn string: The ARN of the image version created on the instance.

InstanceType string: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
LifecycleConfigArn string: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
SagemakerImageArn string: The ARN of the SageMaker image that the image version belongs to.
SagemakerImageVersionArn string: The ARN of the image version created on the instance.

instanceType String: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
lifecycleConfigArn String: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
sagemakerImageArn String: The ARN of the SageMaker image that the image version belongs to.
sagemakerImageVersionArn String: The ARN of the image version created on the instance.

instanceType string: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
lifecycleConfigArn string: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
sagemakerImageArn string: The ARN of the SageMaker image that the image version belongs to.
sagemakerImageVersionArn string: The ARN of the image version created on the instance.

instance_type str: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
lifecycle_config_arn str: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
sagemaker_image_arn str: The ARN of the SageMaker image that the image version belongs to.
sagemaker_image_version_arn str: The ARN of the image version created on the instance.

instanceType String: The instance type that the image version runs on. For valid values see SageMaker Instance Types.
lifecycleConfigArn String: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
sagemakerImageArn String: The ARN of the SageMaker image that the image version belongs to.
sagemakerImageVersionArn String: The ARN of the image version created on the instance.

Import

SageMaker Apps can be imported using the id, e.g.,

 $ pulumi import aws:sagemaker/app:App example arn:aws:sagemaker:us-west-2:012345678912:app/domain-id/user-profile-name/app-type/app-name

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.