Domain

sagemaker.services.k8s.aws/v1alpha1

TypeLink
GoDocsagemaker-controller/apis/v1alpha1#Domain

Metadata

PropertyValue
ScopeNamespaced
KindDomain
ListKindDomainList
Pluraldomains
Singulardomain

Spec

appNetworkAccessType: string
appSecurityGroupManagement: string
authMode: string
defaultUserSettings: 
  executionRole: string
  jupyterServerAppSettings: 
    defaultResourceSpec: 
      instanceType: string
      lifecycleConfigARN: string
      sageMakerImageARN: string
      sageMakerImageVersionARN: string
    lifecycleConfigARNs:
    - string
  kernelGatewayAppSettings: 
    customImages:
    - appImageConfigName: string
      imageName: string
      imageVersionNumber: integer
    defaultResourceSpec: 
      instanceType: string
      lifecycleConfigARN: string
      sageMakerImageARN: string
      sageMakerImageVersionARN: string
    lifecycleConfigARNs:
    - string
  rStudioServerProAppSettings: 
    accessStatus: string
    userGroup: string
  securityGroups:
  - string
  sharingSettings: 
    notebookOutputOption: string
    s3KMSKeyID: string
    s3OutputPath: string
  tensorBoardAppSettings: 
    defaultResourceSpec: 
      instanceType: string
      lifecycleConfigARN: string
      sageMakerImageARN: string
      sageMakerImageVersionARN: string
domainName: string
domainSettings: 
  rStudioServerProDomainSettings: 
    defaultResourceSpec: 
      instanceType: string
      lifecycleConfigARN: string
      sageMakerImageARN: string
      sageMakerImageVersionARN: string
    domainExecutionRoleARN: string
    rStudioConnectURL: string
    rStudioPackageManagerURL: string
  securityGroupIDs:
  - string
homeEFSFileSystemKMSKeyID: string
kmsKeyID: string
subnetIDs:
- string
tags:
- key: string
  value: string
vpcID: string
FieldDescription
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, which allows direct internet access
* VpcOnly - All Studio 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.
authMode
Required
string
The mode of authentication that members use to access the domain.
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.executionRole
Optional
string
defaultUserSettings.jupyterServerAppSettings
Optional
object
The JupyterServer app settings.
defaultUserSettings.jupyterServerAppSettings.defaultResourceSpec
Optional
object
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
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.lifecycleConfigARNs
Optional
array
defaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[]
Required
string
defaultUserSettings.kernelGatewayAppSettings.customImages
Optional
array
defaultUserSettings.kernelGatewayAppSettings.customImages.[]
Required
object
A custom SageMaker image. For more information, see Bring your own SageMaker 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 image and SageMaker image version, and the instance type that the version runs on.
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.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.tensorBoardAppSettings
Optional
object
The TensorBoard app settings.
defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec
Optional
object
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType
Optional
string
defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN
Optional
string
defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN
Optional
string
defaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN
Optional
string
domainName
Required
string
A name for the domain.
domainSettings
Optional
object
A collection of Domain settings.
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 image and SageMaker image version, and the instance type that the version runs on.
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.domainExecutionRoleARN
Optional
string
domainSettings.rStudioServerProDomainSettings.rStudioConnectURL
Optional
string
domainSettings.rStudioServerProDomainSettings.rStudioPackageManagerURL
Optional
string
domainSettings.securityGroupIDs
Optional
array
domainSettings.securityGroupIDs.[]
Required
string
kmsKeyID
Optional
string
SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
subnetIDs
Required
array
The VPC subnets that Studio uses for communication.
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.
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.[].value
Optional
string
vpcID
Required
string
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

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
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that 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. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse 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 that contains a collection of ackv1alpha1.Condition objects that describe the 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.
status
Optional
string
The status.
url
Optional
string
The URL to the created domain.