AWS::SageMaker::App - AWS CloudFormation

AWS::SageMaker::App

Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::SageMaker::App", "Properties" : { "AppName" : String, "AppType" : String, "DomainId" : String, "ResourceSpec" : ResourceSpec, "Tags" : [ Tag, ... ], "UserProfileName" : String } }

YAML

Type: AWS::SageMaker::App Properties: AppName: String AppType: String DomainId: String ResourceSpec: ResourceSpec Tags: - Tag UserProfileName: String

Properties

AppName

The name of the app.

Required: Yes

Type: String

Maximum: 63

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Update requires: Replacement

AppType

The type of app.

Required: Yes

Type: String

Allowed values: JupyterServer | KernelGateway | TensorBoard

Update requires: Replacement

DomainId

The domain ID.

Required: Yes

Type: String

Maximum: 63

Update requires: Replacement

ResourceSpec

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

Required: No

Type: ResourceSpec

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

UserProfileName

The user profile name.

Required: Yes

Type: String

Maximum: 63

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the App type, App name, domain ID, and user profile name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AppArn

The Amazon Resource Name (ARN) of the App, such as arn:aws:sagemaker:us-west-2:account-id:app/my-app-name.