AWS::SageMaker::Space

Creates a private space or a space used for real time collaboration in a domain.

Syntax

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

JSON

{
  "Type" : "AWS::SageMaker::Space",
  "Properties" : {
      "DomainId" : String,
      "OwnershipSettings" : OwnershipSettings,
      "SpaceDisplayName" : String,
      "SpaceName" : String,
      "SpaceSettings" : SpaceSettings,
      "SpaceSharingSettings" : SpaceSharingSettings,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SageMaker::Space
Properties:
  DomainId: String
  OwnershipSettings: 
    OwnershipSettings
  SpaceDisplayName: String
  SpaceName: String
  SpaceSettings: 
    SpaceSettings
  SpaceSharingSettings: 
    SpaceSharingSettings
  Tags: 
    - Tag

Properties

DomainId

The ID of the associated domain.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

OwnershipSettings

The collection of ownership settings for a space.

Required: No

Type: OwnershipSettings

Update requires: Replacement

SpaceDisplayName

The name of the space that appears in the Studio UI.

Required: No

Type: String

Pattern: ^(?!\s*$).+

Maximum: 64

Update requires: No interruption

SpaceName

The name of the space.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

SpaceSettings

A collection of space settings.

Required: No

Type: SpaceSettings

Minimum: 0

Maximum: 50

Update requires: No interruption

SpaceSharingSettings

A collection of space sharing settings.

Required: No

Type: SpaceSharingSettings

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the domain that the space is associated with and the name of the space.

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.

SpaceArn

The space's Amazon Resource Name (ARN).

Url

Returns the URL of the space. If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center.

The following application types are supported:

• Studio Classic: &redirect=JupyterServer

• JupyterLab: &redirect=JupyterLab

• Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor