Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI 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
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Minimum:
1Maximum:
63Update requires: Replacement
AppType-
The type of app.
Required: Yes
Type: String
Allowed values:
JupyterServer | KernelGateway | RStudioServerPro | RSessionGateway | CanvasUpdate requires: Replacement
DomainId-
The domain ID.
Required: Yes
Type: String
Minimum:
1Maximum:
63Update requires: Replacement
ResourceSpec-
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
Required: No
Type: ResourceSpec
Update requires: Replacement
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
50Update requires: Replacement
UserProfileName-
The user profile name.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Minimum:
1Maximum:
63Update requires: Replacement
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.
