aws.sagemaker.App
Explore with Pulumi AI
Provides a SageMaker App resource.
Example Usage
Basic usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.App("example", {
domainId: exampleAwsSagemakerDomain.id,
userProfileName: exampleAwsSagemakerUserProfile.userProfileName,
appName: "example",
appType: "JupyterServer",
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.App("example",
domain_id=example_aws_sagemaker_domain["id"],
user_profile_name=example_aws_sagemaker_user_profile["userProfileName"],
app_name="example",
app_type="JupyterServer")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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(exampleAwsSagemakerDomain.Id),
UserProfileName: pulumi.Any(exampleAwsSagemakerUserProfile.UserProfileName),
AppName: pulumi.String("example"),
AppType: pulumi.String("JupyterServer"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.App("example", new()
{
DomainId = exampleAwsSagemakerDomain.Id,
UserProfileName = exampleAwsSagemakerUserProfile.UserProfileName,
AppName = "example",
AppType = "JupyterServer",
});
});
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());
}
}
resources:
example:
type: aws:sagemaker:App
properties:
domainId: ${exampleAwsSagemakerDomain.id}
userProfileName: ${exampleAwsSagemakerUserProfile.userProfileName}
appName: example
appType: JupyterServer
Create App Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
args: AppArgs,
opts: Optional[ResourceOptions] = None)
@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)
func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs args, CustomResourceOptions? opts = null)
type: aws:sagemaker:App
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 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleappResourceResourceFromSagemakerapp = new Aws.Sagemaker.App("exampleappResourceResourceFromSagemakerapp", new()
{
AppName = "string",
AppType = "string",
DomainId = "string",
ResourceSpec = new Aws.Sagemaker.Inputs.AppResourceSpecArgs
{
InstanceType = "string",
LifecycleConfigArn = "string",
SagemakerImageArn = "string",
SagemakerImageVersionAlias = "string",
SagemakerImageVersionArn = "string",
},
SpaceName = "string",
Tags =
{
{ "string", "string" },
},
UserProfileName = "string",
});
example, err := sagemaker.NewApp(ctx, "exampleappResourceResourceFromSagemakerapp", &sagemaker.AppArgs{
AppName: pulumi.String("string"),
AppType: pulumi.String("string"),
DomainId: pulumi.String("string"),
ResourceSpec: &sagemaker.AppResourceSpecArgs{
InstanceType: pulumi.String("string"),
LifecycleConfigArn: pulumi.String("string"),
SagemakerImageArn: pulumi.String("string"),
SagemakerImageVersionAlias: pulumi.String("string"),
SagemakerImageVersionArn: pulumi.String("string"),
},
SpaceName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserProfileName: pulumi.String("string"),
})
var exampleappResourceResourceFromSagemakerapp = new App("exampleappResourceResourceFromSagemakerapp", AppArgs.builder()
.appName("string")
.appType("string")
.domainId("string")
.resourceSpec(AppResourceSpecArgs.builder()
.instanceType("string")
.lifecycleConfigArn("string")
.sagemakerImageArn("string")
.sagemakerImageVersionAlias("string")
.sagemakerImageVersionArn("string")
.build())
.spaceName("string")
.tags(Map.of("string", "string"))
.userProfileName("string")
.build());
exampleapp_resource_resource_from_sagemakerapp = aws.sagemaker.App("exampleappResourceResourceFromSagemakerapp",
app_name="string",
app_type="string",
domain_id="string",
resource_spec={
"instance_type": "string",
"lifecycle_config_arn": "string",
"sagemaker_image_arn": "string",
"sagemaker_image_version_alias": "string",
"sagemaker_image_version_arn": "string",
},
space_name="string",
tags={
"string": "string",
},
user_profile_name="string")
const exampleappResourceResourceFromSagemakerapp = new aws.sagemaker.App("exampleappResourceResourceFromSagemakerapp", {
appName: "string",
appType: "string",
domainId: "string",
resourceSpec: {
instanceType: "string",
lifecycleConfigArn: "string",
sagemakerImageArn: "string",
sagemakerImageVersionAlias: "string",
sagemakerImageVersionArn: "string",
},
spaceName: "string",
tags: {
string: "string",
},
userProfileName: "string",
});
type: aws:sagemaker:App
properties:
appName: string
appType: string
domainId: string
resourceSpec:
instanceType: string
lifecycleConfigArn: string
sagemakerImageArn: string
sagemakerImageVersionAlias: string
sagemakerImageVersionArn: string
spaceName: string
tags:
string: string
userProfileName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The App resource accepts the following input properties:
- App
Name string - The name of the app.
- App
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - Domain
Id string - The domain ID.
- Resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- Space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - User
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- App
Name string - The name of the app.
- App
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - Domain
Id string - The domain ID.
- Resource
Spec AppResource Spec Args - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- Space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - User
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name String - The name of the app.
- app
Type String - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - domain
Id String - The domain ID.
- resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name String - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - user
Profile StringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name string - The name of the app.
- app
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - domain
Id string - The domain ID.
- resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - {[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. - user
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app_
name str - The name of the app.
- app_
type str - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - domain_
id str - The domain ID.
- resource_
spec AppResource Spec Args - 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
orspace_name
required. - 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_ strname - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name String - The name of the app.
- app
Type String - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - domain
Id String - The domain ID.
- resource
Spec Property Map - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name String - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - user
Profile StringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
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.
- App
Name string - The name of the app.
- App
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - Arn string
- The Amazon Resource Name (ARN) of the app.
- Domain
Id string - The domain ID.
- Resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- Space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- App
Name string - The name of the app.
- App
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - Arn string
- The Amazon Resource Name (ARN) of the app.
- Domain
Id string - The domain ID.
- Resource
Spec AppResource Spec Args - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- Space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name String - The name of the app.
- app
Type String - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - arn String
- The Amazon Resource Name (ARN) of the app.
- domain
Id String - The domain ID.
- resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name String - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Profile StringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name string - The name of the app.
- app
Type string - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - arn string
- The Amazon Resource Name (ARN) of the app.
- domain
Id string - The domain ID.
- resource
Spec AppResource Spec - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name string - The name of the space. At least one of
user_profile_name
orspace_name
required. - {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Profile stringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app_
name str - The name of the app.
- app_
type str - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - arn str
- The Amazon Resource Name (ARN) of the app.
- domain_
id str - The domain ID.
- resource_
spec AppResource Spec Args - 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
orspace_name
required. - 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user_
profile_ strname - The user profile name. At least one of
user_profile_name
orspace_name
required.
- app
Name String - The name of the app.
- app
Type String - The type of app. Valid values are
JupyterServer
,KernelGateway
,RStudioServerPro
,RSessionGateway
,TensorBoard
,CodeEditor
,JupyterLab
,DetailedProfiler
, andCanvas
. - arn String
- The Amazon Resource Name (ARN) of the app.
- domain
Id String - The domain ID.
- resource
Spec Property Map - The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.See Resource Spec below.
- space
Name String - The name of the space. At least one of
user_profile_name
orspace_name
required. - 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Profile StringName - The user profile name. At least one of
user_profile_name
orspace_name
required.
Supporting Types
AppResourceSpec, AppResourceSpecArgs
- Instance
Type string - The instance type that the image version runs on. For valid values see SageMaker Instance Types.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The ARN of the SageMaker image that the image version belongs to.
- Sagemaker
Image stringVersion Alias - The SageMaker Image Version Alias.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- Instance
Type string - The instance type that the image version runs on. For valid values see SageMaker Instance Types.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The ARN of the SageMaker image that the image version belongs to.
- Sagemaker
Image stringVersion Alias - The SageMaker Image Version Alias.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type that the image version runs on. For valid values see SageMaker Instance Types.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The ARN of the SageMaker image that the image version belongs to.
- sagemaker
Image StringVersion Alias - The SageMaker Image Version Alias.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
- instance
Type string - The instance type that the image version runs on. For valid values see SageMaker Instance Types.
- lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image stringArn - The ARN of the SageMaker image that the image version belongs to.
- sagemaker
Image stringVersion Alias - The SageMaker Image Version Alias.
- sagemaker
Image stringVersion Arn - 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_ strarn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker_
image_ strarn - The ARN of the SageMaker image that the image version belongs to.
- sagemaker_
image_ strversion_ alias - The SageMaker Image Version Alias.
- sagemaker_
image_ strversion_ arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type that the image version runs on. For valid values see SageMaker Instance Types.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The ARN of the SageMaker image that the image version belongs to.
- sagemaker
Image StringVersion Alias - The SageMaker Image Version Alias.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
Import
Using pulumi import
, import SageMaker Apps using the id
. For example:
$ pulumi import aws:sagemaker/app:App example arn:aws:sagemaker:us-west-2:012345678912:app/domain-id/user-profile-name/app-type/app-name
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.