Domain
sagemaker.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sagemaker-controller/apis/v1alpha1#Domain |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Domain |
| ListKind | DomainList |
| Plural | domains |
| Singular | domain |
Spec
appNetworkAccessType: string
appSecurityGroupManagement: string
authMode: string
defaultSpaceSettings:
customFileSystemConfigs:
efsFileSystemConfig:
fileSystemID: string
fileSystemPath: string
fSxLustreFileSystemConfig:
fileSystemID: string
fileSystemPath: string
s3FileSystemConfig:
mountPath: string
s3URI: string
customPosixUserConfig:
gid: integer
uid: integer
executionRole: string
jupyterLabAppSettings:
codeRepositories:
- repositoryURL: string
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: integer
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
lifecycleConfigARNs:
- 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
securityGroups:
- string
spaceStorageSettings:
defaultEBSStorageSettings:
defaultEBSVolumeSizeInGb: integer
maximumEBSVolumeSizeInGb: integer
defaultUserSettings:
codeEditorAppSettings:
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
lifecycleConfigARNs:
- string
customFileSystemConfigs:
efsFileSystemConfig:
fileSystemID: string
fileSystemPath: string
fSxLustreFileSystemConfig:
fileSystemID: string
fileSystemPath: string
s3FileSystemConfig:
mountPath: string
s3URI: string
customPosixUserConfig:
gid: integer
uid: integer
defaultLandingURI: string
executionRole: string
jupyterLabAppSettings:
codeRepositories:
- repositoryURL: string
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: integer
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
lifecycleConfigARNs:
- 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
rStudioServerProAppSettings:
accessStatus: string
userGroup: string
securityGroups:
- string
sharingSettings:
notebookOutputOption: string
s3KMSKeyID: string
s3OutputPath: string
spaceStorageSettings:
defaultEBSStorageSettings:
defaultEBSVolumeSizeInGb: integer
maximumEBSVolumeSizeInGb: integer
studioWebPortal: string
tensorBoardAppSettings:
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
domainName: string
domainSettings:
dockerSettings:
enableDockerAccess: string
rootlessDocker: string
vpcOnlyTrustedAccounts:
- string
ipAddressType: string
rStudioServerProDomainSettings:
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
sageMakerImageVersionAlias: string
domainExecutionRoleARN: string
rStudioConnectURL: string
rStudioPackageManagerURL: string
securityGroupIDs:
- string
trustedIdentityPropagationSettings:
status: string
unifiedStudioSettings:
domainAccountID: string
domainID: string
domainRegion: string
environmentID: string
projectID: string
projectS3Path: string
singleSignOnApplicationARN: string
studioWebPortalAccess: string
homeEFSFileSystemKMSKeyID: string
kmsKeyID: string
subnetIDs:
- string
tags:
- key: string
value: string
vpcID: string
| Field | Description |
|---|---|
| appNetworkAccessType Optional | string Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access * VpcOnly - All traffic is through the specified VPC and subnets |
| appSecurityGroupManagement Optional | string The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service. |
| authMode Required | string The mode of authentication that members use to access the domain. |
| defaultSpaceSettings Optional | object The default settings for shared spaces that users create in the domain. |
| defaultSpaceSettings.customFileSystemConfigs Optional | array |
| defaultSpaceSettings.customFileSystemConfigs.[] Required | object The settings for assigning a custom file system to a user profile or space |
| for an Amazon SageMaker AI Domain. Permitted users can access this file system | |
| in Amazon SageMaker AI Studio. | |
| defaultSpaceSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID Optional | string |
| defaultSpaceSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath Optional | string |
| defaultSpaceSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig Optional | object The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain. |
| defaultSpaceSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig.fileSystemID Optional | string |
| defaultSpaceSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig.fileSystemPath Optional | string |
| defaultSpaceSettings.customFileSystemConfigs.[].s3FileSystemConfig Optional | object Configuration for the custom Amazon S3 file system. |
| defaultSpaceSettings.customFileSystemConfigs.[].s3FileSystemConfig.mountPath Optional | string |
| defaultSpaceSettings.customFileSystemConfigs.[].s3FileSystemConfig.s3URI Optional | string |
| defaultSpaceSettings.customPosixUserConfig Optional | object Details about the POSIX identity that is used for file system operations. |
| defaultSpaceSettings.customPosixUserConfig.gid Optional | integer |
| defaultSpaceSettings.customPosixUserConfig.uid Optional | integer |
| defaultSpaceSettings.executionRole Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings Optional | object The settings for the JupyterLab application. |
| defaultSpaceSettings.jupyterLabAppSettings.codeRepositories Optional | array |
| defaultSpaceSettings.jupyterLabAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
| in the JupyterServer application. | |
| defaultSpaceSettings.jupyterLabAppSettings.customImages Optional | array |
| defaultSpaceSettings.jupyterLabAppSettings.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). | |
| defaultSpaceSettings.jupyterLabAppSettings.customImages.[].imageName Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber Optional | integer |
| defaultSpaceSettings.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. |
| defaultSpaceSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultSpaceSettings.jupyterLabAppSettings.lifecycleConfigARNs Optional | array |
| defaultSpaceSettings.jupyterLabAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultSpaceSettings.jupyterServerAppSettings.codeRepositories Optional | array |
| defaultSpaceSettings.jupyterServerAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
| in the JupyterServer application. | |
| defaultSpaceSettings.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. |
| defaultSpaceSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultSpaceSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultSpaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultSpaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultSpaceSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultSpaceSettings.jupyterServerAppSettings.lifecycleConfigARNs Optional | array |
| defaultSpaceSettings.jupyterServerAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultSpaceSettings.kernelGatewayAppSettings.customImages Optional | array |
| defaultSpaceSettings.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). | |
| defaultSpaceSettings.kernelGatewayAppSettings.customImages.[].imageName Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber Optional | integer |
| defaultSpaceSettings.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. |
| defaultSpaceSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultSpaceSettings.kernelGatewayAppSettings.lifecycleConfigARNs Optional | array |
| defaultSpaceSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultSpaceSettings.securityGroups.[] Required | string |
| defaultSpaceSettings.spaceStorageSettings.defaultEBSStorageSettings Optional | object A collection of default EBS storage settings that apply to spaces created within a domain or user profile. |
| defaultSpaceSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb Optional | integer |
| defaultSpaceSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb Optional | integer |
| defaultUserSettings Required | object The default settings to use to create a user profile when UserSettings isn’t specified in the call to the CreateUserProfile API. SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain. |
| defaultUserSettings.codeEditorAppSettings Optional | object The Code Editor application settings. For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html). |
| defaultUserSettings.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. |
| defaultUserSettings.codeEditorAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultUserSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs Optional | array |
| defaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultUserSettings.customFileSystemConfigs.[] Required | object The settings for assigning a custom file system to a user profile or space |
| for an Amazon SageMaker AI Domain. Permitted users can access this file system | |
| in Amazon SageMaker AI Studio. | |
| defaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID Optional | string |
| defaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath Optional | string |
| defaultUserSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig Optional | object The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain. |
| defaultUserSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig.fileSystemID Optional | string |
| defaultUserSettings.customFileSystemConfigs.[].fSxLustreFileSystemConfig.fileSystemPath Optional | string |
| defaultUserSettings.customFileSystemConfigs.[].s3FileSystemConfig Optional | object Configuration for the custom Amazon S3 file system. |
| defaultUserSettings.customFileSystemConfigs.[].s3FileSystemConfig.mountPath Optional | string |
| defaultUserSettings.customFileSystemConfigs.[].s3FileSystemConfig.s3URI Optional | string |
| defaultUserSettings.customPosixUserConfig Optional | object Details about the POSIX identity that is used for file system operations. |
| defaultUserSettings.customPosixUserConfig.gid Optional | integer |
| defaultUserSettings.customPosixUserConfig.uid Optional | integer |
| defaultUserSettings.defaultLandingURI Optional | string |
| defaultUserSettings.executionRole Optional | string |
| defaultUserSettings.jupyterLabAppSettings Optional | object The settings for the JupyterLab application. |
| defaultUserSettings.jupyterLabAppSettings.codeRepositories Optional | array |
| defaultUserSettings.jupyterLabAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
| in the JupyterServer application. | |
| defaultUserSettings.jupyterLabAppSettings.customImages Optional | array |
| defaultUserSettings.jupyterLabAppSettings.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). | |
| defaultUserSettings.jupyterLabAppSettings.customImages.[].imageName Optional | string |
| defaultUserSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber Optional | integer |
| defaultUserSettings.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. |
| defaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs Optional | array |
| defaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultUserSettings.jupyterServerAppSettings.codeRepositories Optional | array |
| defaultUserSettings.jupyterServerAppSettings.codeRepositories.[] Required | object A Git repository that SageMaker AI automatically displays to users for cloning |
| in the JupyterServer application. | |
| defaultUserSettings.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. |
| defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs Optional | array |
| defaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultUserSettings.kernelGatewayAppSettings.customImages Optional | array |
| defaultUserSettings.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). | |
| defaultUserSettings.kernelGatewayAppSettings.customImages.[].imageName Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber Optional | integer |
| defaultUserSettings.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. |
| defaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| defaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs Optional | array |
| defaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[] Required | string |
| defaultUserSettings.rStudioServerProAppSettings.accessStatus Optional | string |
| defaultUserSettings.rStudioServerProAppSettings.userGroup Optional | string |
| defaultUserSettings.securityGroups Optional | array |
| defaultUserSettings.securityGroups.[] Required | string |
| defaultUserSettings.sharingSettings.notebookOutputOption Optional | string |
| defaultUserSettings.sharingSettings.s3KMSKeyID Optional | string |
| defaultUserSettings.sharingSettings.s3OutputPath Optional | string |
| defaultUserSettings.spaceStorageSettings Optional | object The default storage settings for a space. |
| defaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings Optional | object A collection of default EBS storage settings that apply to spaces created within a domain or user profile. |
| defaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb Optional | integer |
| defaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb Optional | integer |
| defaultUserSettings.studioWebPortal Optional | string |
| defaultUserSettings.tensorBoardAppSettings Optional | object The TensorBoard app settings. |
| defaultUserSettings.tensorBoardAppSettings.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. |
| defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType Optional | string |
| defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| domainName Required | string A name for the domain. Regex Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ |
| domainSettings Optional | object A collection of Domain settings. |
| domainSettings.dockerSettings Optional | object A collection of settings that configure the domain’s Docker interaction. |
| domainSettings.dockerSettings.enableDockerAccess Optional | string |
| domainSettings.dockerSettings.rootlessDocker Optional | string |
| domainSettings.dockerSettings.vpcOnlyTrustedAccounts Optional | array |
| domainSettings.dockerSettings.vpcOnlyTrustedAccounts.[] Required | string |
| domainSettings.rStudioServerProDomainSettings Optional | object A collection of settings that configure the RStudioServerPro Domain-level app. |
| domainSettings.rStudioServerProDomainSettings.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. |
| domainSettings.rStudioServerProDomainSettings.defaultResourceSpec.instanceType Optional | string |
| domainSettings.rStudioServerProDomainSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
| domainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
| domainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
| domainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionAlias Optional | string |
| domainSettings.rStudioServerProDomainSettings.domainExecutionRoleARN Optional | string |
| domainSettings.rStudioServerProDomainSettings.rStudioConnectURL Optional | string |
| domainSettings.rStudioServerProDomainSettings.rStudioPackageManagerURL Optional | string |
| domainSettings.securityGroupIDs Optional | array |
| domainSettings.securityGroupIDs.[] Required | string |
| domainSettings.trustedIdentityPropagationSettings.status Optional | string |
| domainSettings.unifiedStudioSettings Optional | object The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio. |
| domainSettings.unifiedStudioSettings.domainAccountID Optional | string |
| domainSettings.unifiedStudioSettings.domainID Optional | string |
| domainSettings.unifiedStudioSettings.domainRegion Optional | string |
| domainSettings.unifiedStudioSettings.environmentID Optional | string |
| domainSettings.unifiedStudioSettings.projectID Optional | string |
| domainSettings.unifiedStudioSettings.projectS3Path Optional | string |
| domainSettings.unifiedStudioSettings.singleSignOnApplicationARN Optional | string |
| domainSettings.unifiedStudioSettings.studioWebPortalAccess Optional | string |
| homeEFSFileSystemKMSKeyID Optional | string Use KmsKeyId. Regex Pattern: ^[a-zA-Z0-9:/_-]*$ |
| kmsKeyID Optional | string SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key. Regex Pattern: ^[a-zA-Z0-9:/_-]*$ |
| subnetIDs Optional | array The VPC subnets that the domain uses for communication. The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio. |
| subnetIDs.[] Required | string |
| 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
|
| vpcID
Optional | string
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for
communication.
The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly
for domains created from Amazon SageMaker Unified Studio.
Regex Pattern: ^[-0-9a-zA-Z]+$ |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
domainID: 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 |
| domainID Optional | string The domain ID. Regex Pattern: ^d-(-*[a-z0-9]){1,61}$ |
| status Optional | string The status. |
| url Optional | string The URL to the created domain. |