NotebookInstance

sagemaker.services.k8s.aws/v1alpha1

TypeLink
GoDocsagemaker-controller/apis/v1alpha1#NotebookInstance

Metadata

PropertyValue
ScopeNamespaced
KindNotebookInstance
ListKindNotebookInstanceList
Pluralnotebookinstances
Singularnotebookinstance

Spec

acceleratorTypes:
- string
additionalCodeRepositories:
- string
defaultCodeRepository: string
directInternetAccess: string
instanceType: string
kmsKeyID: string
lifecycleConfigName: string
notebookInstanceName: string
platformIdentifier: string
roleARN: string
rootAccess: string
securityGroupIDs:
- string
subnetID: string
tags:
- key: string
  value: string
volumeSizeInGB: integer
FieldDescription
acceleratorTypes
Optional		array
A list of Elastic Inference (EI) instance types to associate with this notebook
instance. Currently, only one instance type can be associated with a notebook
instance. For more information, see Using Elastic Inference in Amazon SageMaker
(https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html).
acceleratorTypes.[]
Required		string
additionalCodeRepositories.[]
Required		string
directInternetAccess
Optional		string
Sets whether SageMaker provides internet access to the notebook instance.
If you set this to Disabled this notebook instance is able to access resources
only in your VPC, and is not be able to connect to SageMaker training and
endpoint services unless you configure a NAT Gateway in your VPC.


For more information, see Notebook Instances Are Internet-Enabled by Default
(https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access).
You can set the value of this parameter to Disabled only if you set a value
for the SubnetId parameter.
instanceType
Required		string
The type of ML compute instance to launch for the notebook instance.
kmsKeyID
Optional		string
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service
key that SageMaker uses to encrypt data on the storage volume attached to
your notebook instance. The KMS key you provide must be enabled. For information,
see Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)
in the Amazon Web Services Key Management Service Developer Guide.
lifecycleConfigName
Optional		string
The name of a lifecycle configuration to associate with the notebook instance.
For information about lifestyle configurations, see Step 2.1: (Optional)
Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html).
notebookInstanceName
Required		string
The name of the new notebook instance.
platformIdentifier
Optional		string
The platform identifier of the notebook instance runtime environment.
roleARN
Required		string
When you send any requests to Amazon Web Services resources from the notebook
instance, SageMaker assumes this role to perform tasks on your behalf. You
must grant this role necessary permissions so SageMaker can perform these
tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com)
permissions to assume this role. For more information, see SageMaker Roles
(https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).


To be able to pass this role to SageMaker, the caller of this API must have
the iam:PassRole permission.
rootAccess
Optional		string
Whether root access is enabled or disabled for users of the notebook instance.
The default value is Enabled.


Lifecycle configurations need root access to be able to set up a notebook
instance. Because of this, lifecycle configurations associated with a notebook
instance always run with root access even if you disable root access for
users.
securityGroupIDs
Optional		array
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups
must be for the same VPC as specified in the subnet.
securityGroupIDs.[]
Required		string
tags
Optional		array
An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or
environment. For more information, see Tagging Amazon Web Services Resources
(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
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
| | volumeSizeInGB
Optional | integer
The size, in GB, of the ML storage volume to attach to the notebook instance.
The default value is 5 GB. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
failureReason: string
notebookInstanceStatus: string
stoppedByControllerMetadata: 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
failureReason
Optional		string
If status is Failed, the reason it failed.
notebookInstanceStatus
Optional		string
The status of the notebook instance.
stoppedByControllerMetadata
Optional		string
The URL that you use to connect to the Jupyter notebook that is running in
your notebook instance.
url
Optional		string
The URL that you use to connect to the Jupyter notebook that is running in
your notebook instance.