App class
Provides a SageMaker AI 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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_app" "example" {
domain_id = exampleAwsSagemakerDomain.id
user_profile_name = exampleAwsSagemakerUserProfile.userProfileName
app_name = "example"
app_type = "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.ArrayList;
import java.util.Arrays;
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
Import
Using pulumi import, import SageMaker AI 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
Constructors
- App(String name, {AppArgs? args, CustomResourceOptions? options})
-
Creates a new App.
nameThe Pulumi resource name.argsArguments used to configure this App. The set of arguments for App.optionsResource options controlling this resource's behavior. - App.reference(String urn)
- Creates a typed reference to an existing App resource.
Properties
-
appName
↔ Output<
String> -
The name of the app.
latefinal
-
appType
↔ Output<
String> -
The type of app. Valid values are
JupyterServer,KernelGateway,RStudioServerPro,RSessionGateway,TensorBoard,CodeEditor,JupyterLab,DetailedProfiler, andCanvas.latefinal -
arn
↔ Output<
String> -
ARN of the app.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainId
↔ Output<
String> -
The domain ID.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceSpec
↔ Output<
AppResourceSpec> -
Instance type and the ARN of the SageMaker AI image created on the instance. See Resource Spec below.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
spaceName
↔ Output<
String?> -
The name of the space. At least one of
userProfileNameorspaceNamerequired.latefinal -
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userProfileName
↔ Output<
String?> -
The user profile name. At least one of
userProfileNameorspaceNamerequired.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited