Package com.pulumi.aws.sagemaker

Class App

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.sagemaker.App

public class App
extends com.pulumi.resources.CustomResource

Provides a SageMaker App resource. ## Example Usage ### Basic usage <!--Start PulumiCodeChooser -->

 
 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(exampleAwsSagemakerDomain.id())
             .userProfileName(exampleAwsSagemakerUserProfile.userProfileName())
             .appName("example")
             .appType("JupyterServer")
             .build());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import SageMaker Apps using the `id`. For example: ```sh $ pulumi import aws:sagemaker/app:App example arn:aws:sagemaker:us-west-2:012345678912:app/domain-id/user-profile-name/app-type/app-name ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
App(java.lang.String name)
App(java.lang.String name, AppArgs args)
App(java.lang.String name, AppArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	appName()
com.pulumi.core.Output<java.lang.String>	appType()
com.pulumi.core.Output<java.lang.String>	arn()
com.pulumi.core.Output<java.lang.String>	domainId()
static App	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AppState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<AppResourceSpec>	resourceSpec()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	spaceName()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	userProfileName()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

App

public App(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

App

public App(java.lang.String name,
           AppArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

App

public App(java.lang.String name,
           AppArgs args,
           @Nullable
           com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

appName

public com.pulumi.core.Output<java.lang.String> appName()

Returns:

The name of the app.

appType

public com.pulumi.core.Output<java.lang.String> appType()

Returns:

The type of app. Valid values are `JupyterServer`, `KernelGateway`, `RStudioServerPro`, `RSessionGateway` and `TensorBoard`.

arn

public com.pulumi.core.Output<java.lang.String> arn()

Returns:

The Amazon Resource Name (ARN) of the app.

domainId

public com.pulumi.core.Output<java.lang.String> domainId()

Returns:

The domain ID.

resourceSpec

public com.pulumi.core.Output<AppResourceSpec> resourceSpec()

Returns:

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.

spaceName

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> spaceName()

Returns:

The name of the space. At least one of `user_profile_name` or `space_name` required.

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

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

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

userProfileName

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> userProfileName()

Returns:

The user profile name. At least one of `user_profile_name` or `space_name` required.

get

public static App get(java.lang.String name,
                      com.pulumi.core.Output<java.lang.String> id,
                      @Nullable
                      AppState state,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)

Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.