Space
sagemaker.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | sagemaker-controller/apis/v1alpha1#Space |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | Space |
ListKind | SpaceList |
Plural | spaces |
Singular | space |
Spec
domainID: string
ownershipSettings:
ownerUserProfileName: string
spaceDisplayName: string
spaceName: string
spaceSettings:
appType: string
codeEditorAppSettings:
appLifecycleManagement:
idleSettings:
idleTimeoutInMinutes: integer
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
customFileSystems:
efsFileSystem:
fileSystemID: string
fSxLustreFileSystem:
fileSystemID: string
s3FileSystem:
s3URI: string
jupyterLabAppSettings:
appLifecycleManagement:
idleSettings:
idleTimeoutInMinutes: integer
codeRepositories:
- repositoryURL: string
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
jupyterServerAppSettings:
codeRepositories:
- repositoryURL: string
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
lifecycleConfigARNs:
- string
kernelGatewayAppSettings:
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: integer
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
lifecycleConfigARNs:
- string
remoteAccess: string
spaceManagedResources: string
spaceStorageSettings:
ebsStorageSettings:
ebsVolumeSizeInGb: integer
spaceSharingSettings:
sharingType: string
tags:
- key: string
value: string
Field | Description |
---|---|
domainID Required | string The ID of the associated domain. Regex Pattern: ^d-(-*[a-z0-9]){1,61}$ |
ownershipSettings Optional | object A collection of ownership settings. |
ownershipSettings.ownerUserProfileName Optional | string |
spaceDisplayName Optional | string The name of the space that appears in the SageMaker Studio UI. Regex Pattern: ^(?!\s*$).+$ |
spaceName Required | string The name of the space. Regex Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ |
spaceSettings Optional | object A collection of space settings. |
spaceSettings.appType Optional | string |
spaceSettings.codeEditorAppSettings Optional | object The application settings for a Code Editor space. |
spaceSettings.codeEditorAppSettings.appLifecycleManagement Optional | object Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space. |
spaceSettings.codeEditorAppSettings.appLifecycleManagement.idleSettings Optional | object Settings related to idle shutdown of Studio applications in a space. |
spaceSettings.codeEditorAppSettings.appLifecycleManagement.idleSettings.idleTimeoutInMinutes Optional | integer |
spaceSettings.codeEditorAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on. When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value. |
spaceSettings.codeEditorAppSettings.defaultResourceSpec.instanceType Optional | string |
spaceSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
spaceSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
spaceSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
spaceSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
spaceSettings.customFileSystems Optional | array |
spaceSettings.customFileSystems.[] Required | object A file system, created by you, that you assign to a user profile or space |
for an Amazon SageMaker AI Domain. Permitted users can access this file system | |
in Amazon SageMaker AI Studio. | |
spaceSettings.customFileSystems.[].efsFileSystem.fileSystemID Optional | string |
spaceSettings.customFileSystems.[].fSxLustreFileSystem Optional | object A custom file system in Amazon FSx for Lustre. |
spaceSettings.customFileSystems.[].fSxLustreFileSystem.fileSystemID Optional | string |
spaceSettings.customFileSystems.[].s3FileSystem Optional | object A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio. |
spaceSettings.customFileSystems.[].s3FileSystem.s3URI Optional | string |
spaceSettings.jupyterLabAppSettings Optional | object The settings for the JupyterLab application within a space. |
spaceSettings.jupyterLabAppSettings.appLifecycleManagement Optional | object Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space. |
spaceSettings.jupyterLabAppSettings.appLifecycleManagement.idleSettings Optional | object Settings related to idle shutdown of Studio applications in a space. |
spaceSettings.jupyterLabAppSettings.appLifecycleManagement.idleSettings.idleTimeoutInMinutes Optional | integer |
spaceSettings.jupyterLabAppSettings.codeRepositories Optional | array |
spaceSettings.jupyterLabAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
in the JupyterServer application. | |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on. When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value. |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType Optional | string |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
spaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
spaceSettings.jupyterServerAppSettings Optional | object The JupyterServer app settings. |
spaceSettings.jupyterServerAppSettings.codeRepositories Optional | array |
spaceSettings.jupyterServerAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
in the JupyterServer application. | |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on. When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value. |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType Optional | string |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
spaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
spaceSettings.jupyterServerAppSettings.lifecycleConfigARNs Optional | array |
spaceSettings.jupyterServerAppSettings.lifecycleConfigARNs.[] Required | string |
spaceSettings.kernelGatewayAppSettings.customImages Optional | array |
spaceSettings.kernelGatewayAppSettings.customImages.[] Required | object A custom SageMaker AI image. For more information, see Bring your own SageMaker |
AI image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). | |
spaceSettings.kernelGatewayAppSettings.customImages.[].imageName Optional | string |
spaceSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber Optional | integer |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on. When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value. |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType Optional | string |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
spaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
spaceSettings.kernelGatewayAppSettings.lifecycleConfigARNs Optional | array |
spaceSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[] Required | string |
spaceSettings.spaceManagedResources Optional | string |
spaceSettings.spaceStorageSettings Optional | object The storage settings for a space. |
spaceSettings.spaceStorageSettings.ebsStorageSettings Optional | object A collection of EBS storage settings that apply to both private and shared spaces. |
spaceSettings.spaceStorageSettings.ebsStorageSettings.ebsVolumeSizeInGb Optional | integer |
spaceSharingSettings Optional | object A collection of space sharing settings. |
spaceSharingSettings.sharingType Optional | string |
tags Optional | array Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API. |
tags.[] Required | object A tag object that consists of a key and an optional value, used to manage |
metadata for SageMaker Amazon Web Services resources. |
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).
For more information on adding metadata to your Amazon Web Services resources
with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
For advice on best practices for managing Amazon Web Services resources with
tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services
Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
failureReason: string
homeEFSFileSystemUID: string
status: string
url: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
controllers to indicate terminal states of the CR and its backend AWS | |
service API resource | |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
creationTime Optional | string The creation time. |
failureReason Optional | string The failure reason. |
homeEFSFileSystemUID Optional | string The ID of the space’s profile in the Amazon EFS volume. Regex Pattern: ^\d+$ |
status Optional | string The status. |
url Optional | string Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services 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 |